{"info":{"_postman_id":"50f7a4b1-153a-4779-9226-d37245afe0ba","name":"Partner APIs (1.0.0)","description":"

Introduction

Partner APIs allow our partners to leverage Plum's corporate health insurance platform for their customers.

Partners can:

Get plans
\n
Create a company
\n
Select a default plan for the org
\n
Add members to the company
\n
Get members status
\n
Remove member
\n
Modify member details
\n
Add/Remove dependents
\n
Modify dependent details
\n

You can write us at sales@plumhq.com for any support or queries.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12242224","collectionId":"50f7a4b1-153a-4779-9226-d37245afe0ba","publishedId":"2sA3QtcWTy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-04-03T12:06:59.000Z"},"item":[{"name":"Authentication","item":[],"id":"1b7655dd-c432-468c-829c-eb98eb84b73b","description":"

Plum uses secure API-KEYas the authentication mechanism for all APIs.

We will provide you with

Partner-ID
API-KEY

API-KEY and Partner-ID must be part of the authorization header for all API endpoints.

// Auth header format\nAPI-KEY: <API KEY>\nX-Plum-Partner-ID : <Partner-ID>\n\n

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"68f9f25d-f892-46dc-beed-6742ff343c07"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b67d27c1-efee-40e0-9356-5cc037f5fdc8"}}],"_postman_id":"1b7655dd-c432-468c-829c-eb98eb84b73b"},{"name":"Errors","item":[{"name":"Error JSON Examples","item":[],"id":"f2500734-38b5-451b-b4b2-2154bf80bd1d","description":"

Plum is providing error JSONs in response of 4xx and 5xx status codes.
Some examples:

Members Create API - `400 Bad request`

{\n    \"error\": {\n        \"code\": 2002,\n        \"code_str\": \"PAYLOAD_VALIDATION_ERROR\",\n        \"detail\": \"Bad Payload\"\n    }\n}\n\n

Retrieve API `404 Not Found`

{\n    \"error\": {\n        \"code\": 2004,\n        \"code_str\": \"RESOURCE_NOT_FOUND\",\n        \"detail\": \"The requested resource was not found\"\n    }\n}\n\n

Invalid token `401 Unauthorized`

{\n    \"error\": {\n        \"code\": 2005,\n        \"code_str\": \"AUTHENTICATION_FAILED\",\n        \"detail\": \"Invalid token.\"\n    }\n}\n\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"14b681e3-6cd2-46ac-889f-ac14fd6f8aac"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a86532e2-f108-4584-a250-919b570fdb40"}}],"_postman_id":"f2500734-38b5-451b-b4b2-2154bf80bd1d"},{"name":"Error Codes","item":[],"id":"de4f5717-1e26-4dd1-a17c-84be942b2318","description":"

Custom Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Code String	Detail
2100	Something went wrong.	Oops, Something is wrong. Please write us at tech@plumhq.com
2101	POLICY_RESTRICTONS_NOT_PASSED	Policy restrictions not passed.
2102	API_VALIDATION_ERROR	Can not process request
2103	MEMBER_RESTRICTONS_NOT_PASSED	Member restrictions not passed

Common Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Code String	Detail
2000	DEFAULT_ERROR_CODE	Error
2001	RESOURCE_ACCESS_FORBIDDEN_EXCEPTION	Resource Access is Forbidden
2002	SERVER_ERROR	Oops, Something is wrong
2003	RESOURCE_NOT_FOUND	The requested resource is not found
2004	URL_NOT_FOUND	The requested URL is not found
2005	PARSE_ERROR	Malformed Request
2006	AUTHENTICATION_FAILED	The Access-Token in the header has failed authentication
2007	NOT_AUTHENTICATED	Access-Token missing
2008	PERMISSION_DENIED	The Access-Token in the header is not authorised to make this request
2009	METHOD_NOT_ALLOWED	Method not allowed
2010	NOT_ACCEPTABLE	Request accept header not satisfied
2011	UNSUPPORTED_MEDIA_TYPE	Media type not supported
2012	REQUEST_THROTTLED	Request was throttled
2013	PAYLOAD_VALIDATION_ERROR	Bad Payload
2014	NOT_FOUND	Not Found

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b07aa727-ee47-4e14-95e9-cf4488e30c73"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"df1a0a21-cb98-4840-925a-daae34a372c8"}}],"_postman_id":"de4f5717-1e26-4dd1-a17c-84be942b2318"}],"id":"c95db538-7923-4352-808d-e59a8d47ad5c","description":"

Plum uses standard HTTP status codes for responding to API errors and failures. Errors in 2XX range indicate success, 4XX range indicates failure on the partner’s side, while 5XX range indicate a failure on Plum’s side.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP code	Error code	Description
400	bad-request	The request payload or header is malformed or missing
401	unauthorised	The access-token in the header has failed authentication
403	forbidden	The access-token in the header is not authorised to make this request
404	entity-not-found	The requested resource was not found
500	unable-to-fulfil-request	Something went wrong at Plum’s end
502	bad-gateway	Something went wrong at the Insurance partner’s end
503	service-unavailable	The requested service is down or unavailable at the moment

","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3b6f3abc-90a6-4726-a9af-c3bd1d1522d2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"fa791907-4aeb-4326-af4f-31a84907c3f4"}}],"_postman_id":"c95db538-7923-4352-808d-e59a8d47ad5c"},{"name":"Company","item":[{"name":"Create","id":"47e4e9bf-d0b9-4539-a818-72f0734e383e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies","description":"

Creates an company

Request body can only include one company per request
Response body includes the `companyId` which will uniquely identify the company

\n","urlObject":{"path":["companies"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"2a263160-aca1-4b53-b562-5c7413475fc6","name":"Example","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Blogvault\",\n \"id\": \"ORG764233\",\n \"legalName\": \"Blogvault Technology Pvt Ltd\",\n \"address\": {\n \"line1\": \"A-304\",\n \"line2\": \"Sheet Enclave\",\n \"city\": \"Bangalore\",\n \"state\": \"KA\",\n \"pincode\": 56003\n },\n \"industry\": \"Technology\",\n \"location\": \"Mumbai\",\n \"panNo\": \"AFGA4RPR7\",\n \"gstNo\": \"29AAGSTIN001\",\n \"contactPersonName\": \"Manoj Singh\",\n \"contactPersonEmail\": \"manoj@company.com\",\n \"contactPersonPhone\": \"8888000012\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \n \"id\": \"ORG764233\",\n \"name\": \"Blogvault\",\n \"legalName\": \"Blogvault Technology Pvt Ltd\",\n \"address\": {\n \"line1\": \"A-304\",\n \"line2\": \"Sheet Enclave\",\n \"city\": \"Bangalore\",\n \"state\": \"KA\",\n \"pincode\": 56003\n },\n \"industry\": \"Technology\",\n \"location\": \"Mumbai\",\n \"panNo\": \"AFGA4RPR7\",\n \"gstNo\": \"29AAGSTIN001\",\n \"contactPersonName\": \"Manoj Singh\",\n \"contactPersonEmail\": \"manoj@company.com\",\n \"contactPersonPhone\": 8888000012\n}"}],"_postman_id":"47e4e9bf-d0b9-4539-a818-72f0734e383e"},{"name":"List","id":"8b4419e9-1ecc-4248-b009-1307ed5bce03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/?page=1&pageSize=10","description":"

Get all companies created by partner

Can do pagnitaed call with page and pageSize

\n","urlObject":{"path":["companies",""],"host":["{{BASE}}"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"10"}],"variable":[]}},"response":[{"id":"3bd2abb1-f92e-417f-aeee-28303e1b06d9","name":"Get companies - Paginated","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"}],"url":{"raw":"{{BASE}}/companies/?page=1&pageSize=2","host":["{{BASE}}"],"path":["companies",""],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"pageSize\": 10,\n \"total\": 2,\n \"results\": [\n {\n \"id\": \"ORG764233\",\n \"name\": \"Blogvault\",\n \"legalName\": \"Blogvault Technology Pvt Ltd\",\n \"address\": {\n \"line1\": \"A-304\",\n \"line2\": \"Sheet Enclave\",\n \"city\": \"Bangalore\",\n \"state\": \"KA\",\n \"pincode\": 56003\n },\n \"industry\": \"Technology\",\n \"location\": \"Mumbai\",\n \"panNo\": \"AFGA4RPR7\",\n \"gstNo\": \"29AAGSTIN001\",\n \"contactPersonName\": \"Manoj Singh\",\n \"contactPersonEmail\": \"manoj@company.com\",\n \"contactPersonPhone\": 8888000012\n },\n {\n \"id\": \"ORG289310\",\n \"name\": \"Plum\",\n \"legalName\": \"Plum Pvt Ltd\",\n \"address\": {\n \"line1\": \"A-304\",\n \"line2\": \"Sheet Enclave\",\n \"city\": \"Bangalore\",\n \"state\": \"KA\",\n \"pincode\": 560101\n },\n \"industry\": \"Technology\",\n \"location\": \"Mumbai\",\n \"panNo\": \"AFGA4RPR8\",\n \"gstNo\": \"29AAGSTIN002\",\n \"contactPersonName\": \"Manu Singh\",\n \"contactPersonEmail\": \"manu@plum.com\",\n \"contactPersonPhone\": 8888000011\n }\n ]\n}"}],"_postman_id":"8b4419e9-1ecc-4248-b009-1307ed5bce03"},{"name":"Update","id":"d53b070f-2bd1-434d-8816-a32b73f162a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}","description":"

Update company data

Allowed fields

name
\n
legalName
\n

\n","urlObject":{"path":["companies","{{companyId}}"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"184eb965-db19-4676-8e91-b656adc2626c","name":"Example","originalRequest":{"method":"PUT","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New name\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/WBqgS35edVnWJijHcdr8/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7e36e48b4037877658ed\",\n \"name\": \"New name\",\n \"legalName\": \"Blogvault Technology Pvt Ltd\",\n \"address\": {\n \"line1\": \"A-304\",\n \"line2\": \"Sheet Enclave\",\n \"city\": \"Bangalore\",\n \"state\": \"KA\",\n \"pincode\": 56003\n },\n \"industry\": \"Technology\",\n \"location\": \"Mumbai\",\n \"panNo\": \"AFGA4RPR7\",\n \"gstNo\": \"29AAGSTIN001\",\n \"contactPersonName\": \"Manoj Singh\",\n \"contactPersonEmail\": \"manoj@company.com\",\n \"contactPersonPhone\": 8888000012\n}"}],"_postman_id":"d53b070f-2bd1-434d-8816-a32b73f162a5"},{"name":"Delete","id":"05875538-2a1c-4701-9942-4972aae0ffeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}","description":"

Delete an non-onboarded company (company who do not have any benefit)
It deletes

Company record
\n
All members and dependents in the company
\n

\n","urlObject":{"path":["companies","{{companyId}}"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"5f72e019-7990-4907-b353-e312a9c5a723","name":"Deleted Successfully","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"}],"url":"{{BASE}}/companies/WBqgS35edVnWJijHcdr8"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b9d8f9df-3be1-4772-ae04-5967d6178661","name":"Delete unsuccessful","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"}],"url":"{{BASE}}/companies/WBqgS35edVnWJijHcdr8"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 2013,\n \"code_str\": \"PAYLOAD_VALIDATION_ERROR\",\n \"detail\": \"companyId WBqgS35edVnWJijHcdr8 is active. can not delete\"\n }\n}"},{"id":"6ce1eb40-fefc-4954-8072-07acf92ed8e6","name":"Delete unsuccessful 2","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"}],"url":"{{BASE}}/companies/WBqgS35edVnWJijHcdr8"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 2013,\n \"code_str\": \"PAYLOAD_VALIDATION_ERROR\",\n \"detail\": \"companyId WBqgS35edVnWJijHcdr8 Not found\"\n }\n}"}],"_postman_id":"05875538-2a1c-4701-9942-4972aae0ffeb"},{"name":"Retrieve","id":"c41f779e-28c7-4dd6-981f-ac3b6744e485","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}","description":"

Retrieve the company.

A partner can only retrieve the company that are created by the partner.

\n","urlObject":{"path":["companies","{{companyId}}"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"f97d8c66-fb69-4a5a-871d-7d04ebb3467c","name":"Request Sample","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"url":"{{BASE}}/companies/ORG764233/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ORG764233\",\n \"name\": \"Blogvault\",\n \"legalName\": \"Blogvault Technology Pvt Ltd\",\n \"industry\": \"Technology\",\n \"panNo\": \"AFGA4RPR7\",\n \"gstNo\": \"29AAGSTIN001\",\n \"contactPersonName\": \"Manoj Singh\",\n \"contactPersonEmail\": \"manoj@company.com\",\n \"contactPersonPhone\": 8888000012,\n \"address\": {\n \"line1\": \"A-304\",\n \"line2\": \"Sheet Enclave\",\n \"city\": \"Bangalore\",\n \"state\": \"KA\",\n \"pincode\": 56003\n },\n \"defaultPlan\": {}\n}"}],"_postman_id":"c41f779e-28c7-4dd6-981f-ac3b6744e485"},{"name":"Set Default Plan","id":"4a1c1381-0e47-4909-ab1c-d8b3de202870","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/set-default-plan","description":"

Set default plan for the organisaion and add members without any hassle of selection

\n","urlObject":{"path":["companies","{{companyId}}","set-default-plan"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"3bd2d3b5-e9e0-4e33-a598-b10762dbd220","name":"Example","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"WBqgS35edVnWJijHcdr8\",\n \"autoEnrol\": true,\n \"plan\": {\n \"planId\": \"591a161b406187ee5698\",\n \"name\": \"GOLD (E Plan)\",\n \"benefits\": [\n {\n \"type\": \"gmc\",\n \"default\": {\n \"sumInsured\": 100000\n }\n },\n {\n \"type\": \"gpa\",\n \"default\": {\n \"sumInsured\": 1000000\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/ORG764233/set-default-plan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"orgID\": \"ORG764233\",\n \"success\": true,\n \"message\": \"Company plan set successfully\"\n}"}],"_postman_id":"4a1c1381-0e47-4909-ab1c-d8b3de202870"},{"name":"List Members","id":"b84ec8a1-d947-4bf6-81d8-0dbfc4b6dc39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/members","description":"

Get members of a company.

Can send a memberId (optional) in params to get benefit/membership data of a specific member and their dependents. (Check example #2)

\n","urlObject":{"path":["companies","{{companyId}}","members"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"62c47839-2dc0-42fc-864b-5832ef9929b6","name":"Example","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"url":"{{BASE}}/companies/ORG764233/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 02 Nov 2020 08:26:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"24952"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"members\": [\n {\n \"companyId\": \"ORG764233\",\n \"createdAt\": \"2024-05-28T09:49:44.676Z\",\n \"dob\": \"19-Oct-1994\",\n \"doj\": \"15-Jan-2024\",\n \"eid\": \"partner1\",\n \"email\": \"robert+partner.1@plumhq.com\",\n \"firstName\": \"Robert\",\n \"gender\": \"male\",\n \"lastName\": \"Dean\",\n \"phone\": \"9956834345\",\n \"relationship\": \"self\",\n \"updatedAt\": \"2024-05-28T09:49:45.418Z\",\n \"id\": \"partner1\",\n \"dependents\": [\n {\n \"companyId\": \"ORG764233\",\n \"createdAt\": \"2024-05-28T09:49:44.898Z\",\n \"dob\": \"19-Oct-1994\",\n \"firstName\": \"Jean\",\n \"gender\": \"female\",\n \"lastName\": \"Dean\",\n \"memberId\": \"partner1\",\n \"relationship\": \"spouse\",\n \"updatedAt\": \"2024-05-28T09:49:45.609Z\",\n \"id\": \"partner1.1\"\n },\n {\n \"companyId\": \"ORG764233\",\n \"createdAt\": \"2024-05-28T09:49:45.090Z\",\n \"dob\": \"19-Aug-2017\",\n \"firstName\": \"John\",\n \"gender\": \"male\",\n \"lastName\": \"Dean\",\n \"memberId\": \"partner1\",\n \"relationship\": \"kid\",\n \"updatedAt\": \"2024-05-28T09:49:45.803Z\",\n \"id\": \"partner1.2\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"b84ec8a1-d947-4bf6-81d8-0dbfc4b6dc39"}],"id":"48127581-462f-472b-aac6-228714d7a8c5","description":"

APIs to work with company resources.

Company Attributes

name: [string, mandatory, unique] - Company Unique Short Name
\n
legalName: [string, mandatory] - Company Legal Name
\n
address: [JSON, mandatory]
\n
- line1: [string, mandatory]
- line2: [string, optional]
- city: [string, mandatory]
- state: [string, mandatory]
- pincode: [string, mandatory]
\n
industry: [string, mandatory]
\n
panNo: [string, mandatory]
\n
gstNo: [string, mandatory]
\n
contactPersonName: [string, mandatory]
\n
contactPersonEmail: [string, mandatory] - Valid Email Address
\n
contactPersonPhone: [string, mandatory] - Valid Mobile Number
\n
id: [string, mandatory] - Unique company ID in partners system
\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"20d84d01-6dbf-42d5-b315-fe635e01c47c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5bf5771d-c74d-4eb6-9979-f879e35cfbdf"}}],"_postman_id":"48127581-462f-472b-aac6-228714d7a8c5"},{"name":"Plans","item":[{"name":"List","id":"cfb8b52d-f626-4a06-a4c0-8985111a563e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/plans","description":"

This API tells partners their availble plans

\n","urlObject":{"path":["plans"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"b58dae23-72c8-45dd-a714-609a298f9ded","name":"Get Plans","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"url":"{{BASE}}/plans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Sep 2020 07:03:10 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.8.5"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"128"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"plans\": [\n {\n \"isThisRecommended\": true,\n \"planId\": \"591a161b406187ee5698\",\n \"name\": \"GOLD (E Plan)\",\n \"title\": \"GOLD (E Plan)\",\n \"description\": \"\",\n \"rackRate\": {\n \"family\": [\n {\n \"sumInsured\": 500000,\n \"rate\": 4000\n }\n ]\n },\n \"features\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"benefits\": [\n {\n \"type\": \"gmc\",\n \"sumInsuredChoices\": [\n 500000,\n 800000,\n 1000000\n ],\n \"familyCoverage\": \"e\",\n \"default\": {\n \"sumInsured\": 0\n },\n \"coverage\": []\n },\n {\n \"type\": \"gpa\",\n \"sumInsuredChoices\": [\n 1000000\n ],\n \"default\": {\n \"sumInsured\": 0\n },\n \"familyCoverage\": \"e\",\n \"coverage\": []\n }\n ]\n },\n {\n \"planId\": \"1afbf93a483d8d903774\",\n \"name\": \"GOLD (ESC Plan)\",\n \"title\": \"GOLD (ESC Plan)\",\n \"description\": \"\",\n \"benefits\": [\n {\n \"type\": \"gmc\",\n \"sumInsuredChoices\": [\n 500000,\n 800000,\n 1000000\n ],\n \"default\": {\n \"sumInsured\": 0\n },\n \"familyCoverage\": \"esc\",\n \"coverage\": []\n },\n {\n \"type\": \"gpa\",\n \"sumInsuredChoices\": [\n 1000000\n ],\n \"default\": {\n \"sumInsured\": 0\n },\n \"familyCoverage\": \"e\",\n \"coverage\": []\n }\n ]\n },\n {\n \"planId\": \"f677a875479a8092d6bd\",\n \"name\": \"GOLD (ESCP Plan)\",\n \"title\": \"GOLD (ESCP Plan)\",\n \"description\": \"\",\n \"benefits\": [\n {\n \"type\": \"gmc\",\n \"sumInsuredChoices\": [\n 500000,\n 800000,\n 1000000\n ],\n \"default\": {\n \"sumInsured\": 0\n },\n \"familyCoverage\": \"escp\",\n \"coverage\": []\n },\n {\n \"type\": \"gpa\",\n \"sumInsuredChoices\": [\n 1000000\n ],\n \"default\": {\n \"sumInsured\": 0\n },\n \"familyCoverage\": \"e\",\n \"coverage\": []\n }\n ]\n },\n {\n \"name\": \"SILVER\",\n \"description\": \"\",\n \"benefits\": [\n {\n \"type\": \"gmc\",\n \"sumInsuredChoices\": [\n 100000,\n 200000,\n 300000\n ],\n \"familyCoverageChoices\": [\n \"e\",\n \"esc\"\n ],\n \"coverage\": []\n }\n ]\n },\n {\n \"name\": \"STANDARD\",\n \"title\": \"STANDARD\",\n \"description\": \"\",\n \"benefits\": [\n {\n \"type\": \"gmc\",\n \"sumInsuredChoices\": [\n 100000,\n 200000\n ],\n \"familyCoverageChoices\": [\n \"e\",\n \"esc\"\n ],\n \"coverage\": []\n }\n ]\n }\n ]\n}"}],"_postman_id":"cfb8b52d-f626-4a06-a4c0-8985111a563e"},{"name":"Retrieve","id":"821dc6f9-1a4d-4c9d-bd77-74eabdeaa2c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/plans/{{planId}}","description":"

This API tells partners their availble policy benefits.

\n","urlObject":{"path":["plans","{{planId}}"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"600b7d2c-422f-4388-a5be-a473bf7c45a9","name":"Get Plan","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"}],"url":"{{BASE}}/plan/591a161b406187ee5698"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 07 Sep 2020 07:03:10 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.8.5"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin"},{"key":"Allow","value":"GET, POST"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"128"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"isThisRecommended\": true,\n \"planId\": \"591a161b406187ee5698\",\n \"name\": \"GOLD (E Plan)\",\n \"description\": \"\",\n \"rackRate\": {\n \"family\": [\n {\n \"sumInsured\": 500000,\n \"rate\": 4000\n }\n ]\n },\n \"features\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"benefits\": [\n {\n \"type\": \"gmc\",\n \"sumInsuredChoices\": [\n 500000,\n 800000,\n 1000000\n ],\n \"familyCoverage\": \"e\",\n \"default\": {\n \"sumInsured\": 0\n },\n \"coverage\": []\n },\n {\n \"type\": \"gpa\",\n \"sumInsuredChoices\": [\n 1000000\n ],\n \"default\": {\n \"sumInsured\": 0\n },\n \"familyCoverage\": \"e\",\n \"coverage\": []\n }\n ]\n}"}],"_postman_id":"821dc6f9-1a4d-4c9d-bd77-74eabdeaa2c1"}],"id":"6438a055-0162-4d4d-b833-9c8f901c13b8","description":"

Plans are the base benefits which partner can provide to their members. As of now, we create plans as a one-time configuration and only allow read access.

\n","_postman_id":"6438a055-0162-4d4d-b833-9c8f901c13b8"},{"name":"Members","item":[{"name":"Create","id":"dee0fb29-0bd5-48ab-8c90-bede100f29ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/members","description":"

Add Members in a Company

\n","urlObject":{"path":["companies","{{companyId}}","members"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"b3bc7e67-33d6-45e9-a90d-84af4447975a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"firstName\": \"Betty\",\n \"lastName\": \"Howard\",\n \"dateOfBirth\": \"23-Jan-1990\",\n \"dateOfJoining\": \"20-Dec-2020\",\n \"gender\": \"female\",\n \"email\": \"bettyhoward@example.com\",\n \"phone\": \"+919999000011\",\n \"eid\": \"101\",\n \"id\": \"MEM187901\",\n \"homeAddress\": \"Flat 10B, Skyline Enclave, Sector 76, Noida, IN\",\n \"planTitle\": \"5L GMC, GPA, VTU and Other benefits\",\n \"ctc\": 1000000,\n \"dependents\": [\n {\n \"firstName\": \"Deborah\",\n \"lastName\": \"Foster\",\n \"relationship\": \"spouse\",\n \"gender\": \"male\",\n \"id\": \"DEP384942\",\n \"dateOfBirth\": \"25-Sep-1991\"\n },\n {\n \"firstName\": \"Seth\",\n \"lastName\": \"Howard\",\n \"relationship\": \"parent\",\n \"gender\": \"male\",\n \"id\": \"DEP236854\",\n \"dateOfBirth\": \"23-Apr-1952\"\n },\n {\n \"firstName\": \"Tim\",\n \"lastName\": \"Howard\",\n \"dateOfBirth\": \"13-Nov-1957\",\n \"relationship\": \"parent\",\n \"id\": \"DEP28584\",\n \"gender\": \"female\"\n }\n ]\n },\n {\n \"firstName\": \"Doris\",\n \"lastName\": \"Nelson\",\n \"gender\": \"male\",\n \"dateOfBirth\": \"23-Jan-1990\",\n \"dateOfJoining\": \"20-Dec-2020\",\n \"email\": \"dorisnelson@example.com'\",\n \"phone\": \"+919999000012\",\n \"eid\": \"102\",\n \"id\": \"MEM751000\",\n \"ctc\": 1200000,\n \"dependents\": [\n {\n \"firstName\": \"Cynthia\",\n \"lastName\": \"Ruiz\",\n \"relationship\": \"spouse\",\n \"gender\": \"female\",\n \"id\": \"DEP920343\",\n \"dateOfBirth\": \"25-Sep-1991\"\n },\n {\n \"firstName\": \"William\",\n \"relationship\": \"parent\",\n \"gender\": \"male\",\n \"dateOfBirth\": \"23-Apr-1952\",\n \"id\": \"DEP317191\",\n \"lastName\": \"Nelson\"\n },\n {\n \"firstName\": \"Connie\",\n \"relationship\": \"parent\",\n \"gender\": \"female\",\n \"dateOfBirth\": \"13-Nov-1957\",\n \"id\": \"DEP947657\",\n \"lastName\": \"Nelson\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/ORG764233/members"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Members added successfully\"\n}"},{"id":"11287e58-aa43-4e5b-beff-98280a6dddc1","name":"Company not found","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"id\": \"MEM187901\",\n \"firstName\": \"Betty\",\n \"lastName\": \"Howard\",\n \"eid\": \"101\",\n \"dateOfBirth\": \"23-Jan-1990\",\n \"dateOfJoining\": \"20-Dec-2020\",\n \"gender\": \"female\",\n \"email\": \"bettyhoward@example.com\",\n \"phone\": \"9999000011\",\n \"homeAddress\": \"Flat 10B, Skyline Enclave, Sector 76, Noida, IN\",\n \"planTitle\": \"5L GMC, GPA, VTU and Other benefits\",\n \"ctc\": 1000000,\n \"dependents\": [\n {\n \"firstName\": \"Deborah\",\n \"lastName\": \"Foster\",\n \"relationship\": \"spouse\",\n \"gender\": \"male\",\n \"id\": \"DEP384942\",\n \"dateOfBirth\": \"25-Sep-1991\"\n },\n {\n \"firstName\": \"Seth\",\n \"lastName\": \"Howard\",\n \"relationship\": \"parent\",\n \"gender\": \"male\",\n \"id\": \"DEP236854\",\n \"dateOfBirth\": \"23-Apr-1952\"\n },\n {\n \"firstName\": \"Tim\",\n \"lastName\": \"Howard\",\n \"dateOfBirth\": \"13-Nov-1957\",\n \"relationship\": \"parent\",\n \"id\": \"DEP28584\",\n \"gender\": \"female\"\n }\n ]\n },\n {\n \"id\": \"MEM751000\",\n \"firstName\": \"Doris\",\n \"lastName\": \"Nelson\",\n \"gender\": \"male\",\n \"dateOfBirth\": \"23-Jan-1990\",\n \"dateOfJoining\": \"20-Dec-2020\",\n \"email\": \"dorisnelson@example.com'\",\n \"phone\": \"9999000012\",\n \"eid\": \"102\",\n \"ctc\": 1200000,\n \"dependents\": [\n {\n \"firstName\": \"Cynthia\",\n \"lastName\": \"Ruiz\",\n \"relationship\": \"spouse\",\n \"gender\": \"female\",\n \"id\": \"DEP920343\",\n \"dateOfBirth\": \"25-Sep-1991\"\n },\n {\n \"firstName\": \"William\",\n \"relationship\": \"parent\",\n \"gender\": \"male\",\n \"dateOfBirth\": \"23-Apr-1952\",\n \"id\": \"DEP317191\",\n \"lastName\": \"Nelson\"\n },\n {\n \"firstName\": \"Connie\",\n \"relationship\": \"parent\",\n \"gender\": \"female\",\n \"dateOfBirth\": \"13-Nov-1957\",\n \"id\": \"DEP947657\",\n \"lastName\": \"Nelson\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/ORG764233/members"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"code\": 2013,\n \"code_str\": \"PAYLOAD_VALIDATION_ERROR\",\n \"detail\": \"Bad Payload\",\n \"data\": {\n \"companyId\": [\n \"companyId ORG764233 Not found\"\n ]\n }\n }\n}\n"}],"_postman_id":"dee0fb29-0bd5-48ab-8c90-bede100f29ee"},{"name":"Retrieve","id":"719aa21d-35d1-4f5c-8441-1a6eb42bd325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/members/{{memberId}}","description":"

Retrieve a member.

\n","urlObject":{"path":["companies","{{companyId}}","members","{{memberId}}"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"00e35287-040b-4656-b53d-b9b7b8a14b91","name":"Example","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"url":"{{BASE}}/companies/ORG764233/members/partner1/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"companyId\": \"ORG764233\",\n \"createdAt\": \"2024-05-28T09:49:44.676Z\",\n \"dateOfBirth\": \"19-Oct-1994\",\n \"dateOfJoining\": \"15-Jan-2024\",\n \"eid\": \"partner1\",\n \"email\": \"robert+partner.1@plumhq.com\",\n \"firstName\": \"Robert\",\n \"gender\": \"male\",\n \"lastName\": \"Dean\",\n \"phone\": \"9956834345\",\n \"relationship\": \"self\",\n \"updatedAt\": \"2024-05-28T09:49:45.418Z\",\n \"id\": \"partner1\",\n \"dependents\": [\n {\n \"companyId\": \"ORG764233\",\n \"createdAt\": \"2024-05-28T09:49:44.898Z\",\n \"dateOfBirth\": \"19-Oct-1994\",\n \"firstName\": \"Jean\",\n \"gender\": \"female\",\n \"lastName\": \"Dean\",\n \"memberId\": \"partner1\",\n \"relationship\": \"spouse\",\n \"status\": \"ADDITION_QUEUED\",\n \"updatedAt\": \"2024-05-28T09:49:45.609Z\",\n \"id\": \"partner1.1\"\n },\n {\n \"companyId\": \"ORG764233\",\n \"createdAt\": \"2024-05-28T09:49:45.090Z\",\n \"dateOfBirth\": \"19-Aug-2017\",\n \"firstName\": \"John\",\n \"gender\": \"male\",\n \"lastName\": \"Dean\",\n \"memberId\": \"partner1\",\n \"relationship\": \"kid\",\n \"status\": \"ADDITION_QUEUED\",\n \"updatedAt\": \"2024-05-28T09:49:45.803Z\",\n \"id\": \"partner1.2\"\n }\n ]\n}"}],"_postman_id":"719aa21d-35d1-4f5c-8441-1a6eb42bd325"},{"name":"Update","id":"529cb1cc-2d11-4b10-890c-d707c587b91b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/members/{{memberId}}","description":"

Update member data

Allowed fields

firstName
\n
lastName
\n
dateOfBirth
\n
gender
\n

\n","urlObject":{"path":["companies","{{companyId}}","members","{{memberId}}"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"3d4df117-2395-47dd-a2bf-e69fa18096f2","name":"200","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Betty\",\n \"lastName\": \"Hovard\",\n \"email\": \"bettyhovard@example.com\",\n \"gender\": \"male\",\n \"phone\": \"+919999000012\",\n \"dateOfBirth\": \"24-Jan-1990\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/ORG764233/members/MEM187901"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Member updated\"\n}\n"}],"_postman_id":"529cb1cc-2d11-4b10-890c-d707c587b91b"},{"name":"Remove","id":"9ffb626e-bdfc-4a24-b7ba-dbde625b662c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"body":{"mode":"raw","raw":"{\n \"dos\": \"19-Mar-2024\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/{{companyId}}/members/{{memberId}}/remove","description":"

Suspend/Remove a member for all benefits

\n","urlObject":{"path":["companies","{{companyId}}","members","{{memberId}}","remove"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"3b53521f-8949-4096-bd10-9aafc27c1b02","name":"Example","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dateOfExit\": \"02-Feb-2024\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/ORG764233/members/MEM187901"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Member deleted\"\n}"}],"_postman_id":"9ffb626e-bdfc-4a24-b7ba-dbde625b662c"},{"name":"Magic Link","id":"ed5c223e-e0ad-47d4-bb52-2c5c0dd69a65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/members/{{memberId}}/magic-link","description":"

We enable partners to provide a logged-in experience to their members using the passwordless-login API.

Member can see a login to plum on partners dashboard and this API redirects member to their plum dashboard.

We recommened partners to create an API like /goToPlum, which internally hits this API and redirects member to their plum dashboard.

\n","urlObject":{"path":["companies","{{companyId}}","members","{{memberId}}","magic-link"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"13ea495e-6d70-4551-b837-5b018dd25b67","name":"Example","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"url":"{{BASE}}/companies/ORG764233/members/MEM187901/magic-link"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"link\": \"https://go.plumhq.com/MEM187901/login/code=1234\"\n}"}],"_postman_id":"ed5c223e-e0ad-47d4-bb52-2c5c0dd69a65"},{"name":"Unified Sync","id":"22301a76-7df9-4ce8-95d2-311de5f7985c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"}],"url":"{{BASE}}/sync/members","description":"

This API allows partner systems to synchronize employee (member) details with Plum, including full employee profiles, exit updates, personal info changes, and dependent updates.

All requests must include the complete member object, including all dependents (if any), even for partial updates.

How to use

1. New Member

Submit the entire member object with all details.
\n
dateOfExit must be omitted for active employees.
\n

2. Exit Member

To mark a member as exited:
\n
- Include the dateOfExit field.
  \n
- Still send the entire member object with all dependents.
  \n
\n

3. Update Member Details

For any updates (e.g., name, date of birth, gender):
\n
- Send the full updated object, not just the changed field(s).
  \n
- Must include all existing dependents.
  \n
\n

4. Add/Update Dependents

For adding a new dependent or updating existing ones:
\n
- Send the complete list of dependents (existing + new/updated).
  \n
- Partial lists will result in data being overwritten.
  \n
\n

\n","urlObject":{"path":["sync","members"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"f40979ea-0c46-48ef-aec9-353daabef686","name":"New member","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"id\": \"f7c9b180-0c85-4a2e-91c4-643a8e5c4c7f\",\n \"eid\": \"WC00987\",\n \"firstName\": \"Ethan\",\n \"lastName\": \"Reed\",\n \"email\": \"ethan.reed@examplemail.com\",\n \"phone\": \"9876543210\",\n \"dateOfJoining\": \"10-Mar-2023\",\n \"dateOfCommencement\": \"10-Mar-2023\",\n \"dateOfBirth\": \"25-Dec-1990\",\n \"gender\": \"male\",\n \"relationship\": \"self\",\n \"companyId\": \"b8c270f1-df2b-4b3f-9f3d-8fae12f2c1a2\",\n \"companyName\": \"NovaByte Technologies Ltd.\",\n \"homeAddress\": \"45B Elm Street, Maple Residency, HSR Layout, Bengaluru, IN\",\n \"planTitle\": \"5L GMC, GPA, VTU and Other benefits\",\n \"dependents\": [\n {\n \"id\": \"a84e47cf-7682-41a0-a3ef-cfb2b0d5e17f\",\n \"firstName\": \"Olivia\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"14-Feb-1992\",\n \"gender\": \"female\",\n \"relationship\": \"spouse\"\n },\n {\n \"id\": \"2e93aa77-12d0-463c-bdc3-e6f8a5790a0a\",\n \"firstName\": \"Lucas\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"30-Jul-2016\",\n \"gender\": \"male\",\n \"relationship\": \"kid\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/sync/members"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Members synced successfully\"\n}"},{"id":"a7ae0f9a-5bb0-4e1f-8268-ae47dc9a22ff","name":"New dependent","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"id\": \"f7c9b180-0c85-4a2e-91c4-643a8e5c4c7f\",\n \"eid\": \"WC00987\",\n \"firstName\": \"Ethan\",\n \"lastName\": \"Reed\",\n \"email\": \"ethan.reed@examplemail.com\",\n \"phone\": \"9876543210\",\n \"dateOfJoining\": \"10-Mar-2023\",\n \"dateOfCommencement\": \"10-Mar-2023\",\n \"dateOfBirth\": \"25-Dec-1990\",\n \"gender\": \"male\",\n \"relationship\": \"self\",\n \"companyId\": \"b8c270f1-df2b-4b3f-9f3d-8fae12f2c1a2\",\n \"companyName\": \"NovaByte Technologies Ltd.\",\n \"homeAddress\": \"45B Elm Street, Maple Residency, HSR Layout, Bengaluru, IN\",\n \"planTitle\": \"5L GMC, GPA, VTU and Other benefits\",\n \"dependents\": [\n {\n \"id\": \"a84e47cf-7682-41a0-a3ef-cfb2b0d5e17f\",\n \"firstName\": \"Olivia\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"14-Feb-1992\",\n \"gender\": \"female\",\n \"relationship\": \"spouse\"\n },\n {\n \"id\": \"2e93aa77-12d0-463c-bdc3-e6f8a5790a0a\",\n \"firstName\": \"Lucas\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"30-Jul-2016\",\n \"gender\": \"male\",\n \"relationship\": \"kid\"\n },\n {\n \"id\": \"153ac094-fc72-47b9-9426-5456d58161cc\",\n \"firstName\": \"John\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"30-Jan-2025\",\n \"gender\": \"male\",\n \"relationship\": \"kid\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/sync/members"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Members synced successfully\"\n}"},{"id":"209c15a7-cedc-4637-a2a1-efbe81a7cdaf","name":"Update details","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"id\": \"f7c9b180-0c85-4a2e-91c4-643a8e5c4c7f\",\n \"eid\": \"WC00987\",\n \"firstName\": \"Ethan\",\n \"lastName\": \"W Reed\",\n \"email\": \"ethan.reed@examplemail.com\",\n \"phone\": \"9876543210\",\n \"dateOfJoining\": \"10-Mar-2023\",\n \"dateOfCommencement\": \"10-Mar-2023\",\n \"dateOfBirth\": \"25-Dec-1990\",\n \"gender\": \"male\",\n \"relationship\": \"self\",\n \"companyId\": \"b8c270f1-df2b-4b3f-9f3d-8fae12f2c1a2\",\n \"companyName\": \"NovaByte Technologies Ltd.\",\n \"homeAddress\": \"45B Elm Street, Maple Residency, HSR Layout, Bengaluru, IN\",\n \"planTitle\": \"5L GMC, GPA, VTU and Other benefits\",\n \"dependents\": [\n {\n \"id\": \"a84e47cf-7682-41a0-a3ef-cfb2b0d5e17f\",\n \"firstName\": \"Olivia\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"14-Feb-1992\",\n \"gender\": \"female\",\n \"relationship\": \"spouse\"\n },\n {\n \"id\": \"2e93aa77-12d0-463c-bdc3-e6f8a5790a0a\",\n \"firstName\": \"Lucas\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"30-Jul-2016\",\n \"gender\": \"male\",\n \"relationship\": \"kid\"\n },\n {\n \"id\": \"153ac094-fc72-47b9-9426-5456d58161cc\",\n \"firstName\": \"John\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"30-Jan-2025\",\n \"gender\": \"male\",\n \"relationship\": \"kid\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/sync/members"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Members synced successfully\"\n}"},{"id":"aacb2e5f-87ea-4863-9d0f-91e45d55c2d2","name":"Exit member","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"id\": \"f7c9b180-0c85-4a2e-91c4-643a8e5c4c7f\",\n \"eid\": \"WC00987\",\n \"firstName\": \"Ethan\",\n \"lastName\": \"Reed\",\n \"email\": \"ethan.reed@examplemail.com\",\n \"phone\": \"9876543210\",\n \"dateOfExit\": \"28-Mar-2025\",\n \"dateOfJoining\": \"10-Mar-2023\",\n \"dateOfCommencement\": \"10-Mar-2023\",\n \"dateOfBirth\": \"25-Dec-1990\",\n \"gender\": \"male\",\n \"relationship\": \"self\",\n \"companyId\": \"b8c270f1-df2b-4b3f-9f3d-8fae12f2c1a2\",\n \"companyName\": \"NovaByte Technologies Ltd.\",\n \"homeAddress\": \"45B Elm Street, Maple Residency, HSR Layout, Bengaluru, IN\",\n \"planTitle\": \"5L GMC, GPA, VTU and Other benefits\",\n \"dependents\": [\n {\n \"id\": \"a84e47cf-7682-41a0-a3ef-cfb2b0d5e17f\",\n \"firstName\": \"Olivia\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"14-Feb-1992\",\n \"gender\": \"female\",\n \"relationship\": \"spouse\"\n },\n {\n \"id\": \"2e93aa77-12d0-463c-bdc3-e6f8a5790a0a\",\n \"firstName\": \"Lucas\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"30-Jul-2016\",\n \"gender\": \"male\",\n \"relationship\": \"kid\"\n },\n {\n \"id\": \"153ac094-fc72-47b9-9426-5456d58161cc\",\n \"firstName\": \"John\",\n \"lastName\": \"Reed\",\n \"dateOfBirth\": \"30-Jan-2025\",\n \"gender\": \"male\",\n \"relationship\": \"kid\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/sync/members"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Members synced successfully\"\n}"},{"id":"3eb56996-2766-4844-b6fe-8e56a735b5dd","name":"Validation failure","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"members\": [\n {\n \"id\": \"\",\n \"eid\": \"I01476\",\n \"firstName\": \"Mehul\",\n \"lastName\": \"Desai\",\n \"email\": \"mehul.desai@crystaldata.in\",\n \"phone\": \"9867345210\",\n \"dateOfJoining\": \"22-03-2025\",\n \"dateOfCommencement\": \"22-03-2025\",\n \"dateOfBirth\": \"04-10-1991\",\n \"gender\": \"male\",\n \"companyId\": \"a92f4cd1-3a57-4268-b49e-3f9f51e27331\",\n \"companyName\": \"Crystal Data Systems Pvt. Ltd.\",\n \"dependents\": [\n {\n \"id\": \"\",\n \"firstName\": \"Anjali\",\n \"lastName\": \"Desai\",\n \"dateOfBirth\": \"10-01-1992\",\n \"gender\": \"female\",\n \"relationship\": \"spouse\"\n },\n {\n \"id\": \"aa4e0a6f-ea92-48fc-8f04-0e5d6d3f48ab\",\n \"firstName\": \"Kiaan\",\n \"lastName\": \"Desai\",\n \"dateOfBirth\": \"15-Apr-2021\",\n \"gender\": \"male\",\n \"relationship\": \"kid\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/sync/members"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": true,\n \"message\": \"Validation failure\",\n \"data\": {\n \"validationFailures\": [\n {\n \"code\": \"too_small\",\n \"minimum\": 1,\n \"type\": \"string\",\n \"inclusive\": true,\n \"exact\": false,\n \"message\": \"String must contain at least 1 character(s)\",\n \"path\": [\n \"members\",\n 0,\n \"id\"\n ]\n },\n {\n \"code\": \"custom\",\n \"message\": \"Invalid date format. Use DD-MMM-YYYY (e.g., 01-Jan-2023)\",\n \"path\": [\n \"members\",\n 0,\n \"dateOfBirth\"\n ]\n },\n {\n \"code\": \"custom\",\n \"message\": \"Invalid date format. Use DD-MMM-YYYY (e.g., 01-Jan-2023)\",\n \"path\": [\n \"members\",\n 0,\n \"dateOfJoining\"\n ]\n },\n {\n \"code\": \"too_small\",\n \"minimum\": 1,\n \"type\": \"string\",\n \"inclusive\": true,\n \"exact\": false,\n \"message\": \"String must contain at least 1 character(s)\",\n \"path\": [\n \"members\",\n 0,\n \"dependents\",\n 0,\n \"id\"\n ]\n },\n {\n \"code\": \"custom\",\n \"message\": \"Invalid date format. Use DD-MMM-YYYY (e.g., 01-Jan-2023)\",\n \"path\": [\n \"members\",\n 0,\n \"dependents\",\n 0,\n \"dateOfBirth\"\n ]\n }\n ]\n }\n}"}],"_postman_id":"22301a76-7df9-4ce8-95d2-311de5f7985c"}],"id":"12af28a9-d032-4486-b65b-e03882c20daa","description":"

APIs to work with members in a company.

Member/Employee Attributes

id: [string, mandatory] - Employee unique Id in the partner system
\n
firstName: [string, mandatory]
\n
lastName: [string, optional]
\n
eid: [string, mandatory] - Employee Id in the company
\n
gender: [string, mandatory] - Choices = [male, female, other]
\n
dateOfBirth: [date, mandatory] - DD-MMM-YYYY or \"%d-%b-%Y\" i.e. 25-May-1985
\n
dateOfJoining: [date, mandatory] - DD-MMM-YYYY or \"%d-%b-%Y\" i.e. 20-Dec-2020
\n
dateOfCommencement: [date, optional] - DD-MMM-YYYY or \"%d-%b-%Y\" i.e. 20-Dec-2020
\n
phone: [string, mandatory]
\n
email: [email, mandatory]
\n
homeAddress: [string, optional]
\n
ctc: [number, optional] - INR currency
\n

Dependent Attributes

id: [string, mandatory] - Unique Dependent ID in partners system
\n
firstName: [string, mandatory]
\n
lastName: [string, optional]
\n
dateOfBirth: [date, mandatory] DD-MMM-YYYY also \"%d-%b-%Y\" as 10-Apr-2008
\n
gender: [string, mandatory] - Choices = [male, female, other]
\n
relationship: [string, mandatory] - Choices = [parent, spouse, kid]
\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"6f2d2e1f-1e4a-4e3b-a3e3-034bad69711b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"e1fb1d51-0dd9-40dd-8fad-b0f7b71714c4"}}],"_postman_id":"12af28a9-d032-4486-b65b-e03882c20daa"},{"name":"Dependents","item":[{"name":"Create","id":"e9899369-cb43-45b7-8b46-ad68786f9aa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/members/{{memberId}}/dependents","description":"

Add dependent for a members

\n","urlObject":{"path":["companies","{{companyId}}","members","{{memberId}}","dependents"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"2b2ee010-05fa-4f55-8090-948fddde1489","name":"Example","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"relationship\": \"spouse\",\n \"gender\": \"female\",\n \"dateOfBirth\": \"25-Sep-1991\",\n \"lastName\": \"Kamkar\",\n \"firstName\": \"Payel\",\n \"id\": \"DEP356375\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/ORG764233/members/MEM187901/dependents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Dependent added successfully\"\n}"}],"_postman_id":"e9899369-cb43-45b7-8b46-ad68786f9aa1"},{"name":"Retrieve","id":"7e7aca0e-233e-454d-9317-f8dcba6710e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/members/{{memberId}}/dependents/{{dependentId}}","description":"

Retrieve a dependent

\n","urlObject":{"path":["companies","{{companyId}}","members","{{memberId}}","dependents","{{dependentId}}"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"8a43072b-bbe5-4b66-904e-073bed324a73","name":"Example","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"url":"{{BASE}}/companies/ORG764233/members/MEM187901/dependents/DEP356375"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"DEP356375\",\n \"memberId\": \"MEM187901\",\n \"relationship\": \"spouse\",\n \"gender\": \"female\",\n \"dateOfBirth\": \"25-Sep-1991\",\n \"lastName\": \"Kamkar\",\n \"firstName\": \"Payel\"\n}"}],"_postman_id":"7e7aca0e-233e-454d-9317-f8dcba6710e4"},{"name":"Remove","id":"36cf2cee-63fb-49f0-969f-5fcb713d68a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/members/{{memberId}}/dependents/{{dependentId}}","description":"

Remove a dependent for a members

\n","urlObject":{"path":["companies","{{companyId}}","members","{{memberId}}","dependents","{{dependentId}}"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"b3fa5b8f-74ef-49f6-bf47-be6790cd81ce","name":"Example","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dateOfExit\": \"02-Feb-2024\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/ORG764233/members/MEM187901/dependents/DEP356375"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Dependent deleted\"\n}"}],"_postman_id":"36cf2cee-63fb-49f0-969f-5fcb713d68a7"},{"name":"Update","id":"f128d872-3319-40a9-ab62-978af0ae4604","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"API-KEY","value":"{{API-KEY}}"},{"key":"X-Plum-Partner-ID","value":"{{PARTNER-ID}}"}],"url":"{{BASE}}/companies/{{companyId}}/members/{{memberId}}/dependents/{{dependentId}}","description":"

Update dependent

Allowed fields

firstName
\n
lastName
\n
dateOfBirth
\n
gender
\n
relationship
\n

\n","urlObject":{"path":["companies","{{companyId}}","members","{{memberId}}","dependents","{{dependentId}}"],"host":["{{BASE}}"],"query":[],"variable":[]}},"response":[{"id":"498c8ffb-0dd8-4a68-a2b8-5d7142907039","name":"Example","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"{{API-KEY}}","type":"text"},{"key":"X-Plum-Partner-ID","value":"{{Partner-ID}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Payal\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE}}/companies/ORG764233/members/MEM187901/dependents/DEP356375"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Dependent updated\"\n}"}],"_postman_id":"f128d872-3319-40a9-ab62-978af0ae4604"}],"id":"5dd55cd7-3c0a-4549-a0c6-5d9ff7afc671","description":"

APIs to work with dependents in a company.

Dependent Attributes

id: [string, mandatory] - Unique Dependent ID in partners system
\n
firstName: [string, mandatory]
\n
lastName: [string, mandatory]
\n
dependentId:[string, mandatory] Unique Dependent ID in partners system
\n
dateOfBirth: [date, mandatory] DD-MMM-YYYY also \"%d-%b-%Y\" as 10-Apr-2008
\n
gender: [string, mandatory] - Choices = [male, female, other]
\n
relationship: [string, mandatory] - Choices = [parent, spouse, kid, sibling]
\n
dateOfMarriage: [date, optional] DD-MMM-YYYY. Mandatory for spouse mid-term addition; optional otherwise.
\n

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"683bdeb4-1b60-46c2-a4d2-f2522b4199b4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"df97834f-73de-4c51-9d2b-722aa89b5cdf"}}],"_postman_id":"5dd55cd7-3c0a-4549-a0c6-5d9ff7afc671"}],"event":[{"listen":"prerequest","script":{"id":"24d1b27d-4ae8-4f2c-bf54-3f6be88574c6","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"a4006df5-0fa2-433e-b69c-91e8cfcaabae","type":"text/javascript","requests":{},"exec":[""]}}]}

Members Create API - 400 Bad request

Retrieve API 404 Not Found

Invalid token 401 Unauthorized

Custom Codes

Common Codes

Company Attributes

How to use

1. New Member

2. Exit Member

3. Update Member Details

4. Add/Update Dependents

Member/Employee Attributes

Dependent Attributes

Dependent Attributes

Members Create API - `400 Bad request`

Retrieve API `404 Not Found`

Invalid token `401 Unauthorized`