This documentation is about RAIN’s Data Ingestion API which allows clients to securely send Eligible Employees (EE) and Timekeeping (TK) data to RAIN's system.
\nHR, Payroll, and Timekeeping providers that want to integrate with RAIN’s platform to provide Earned Wage Access (EWA) capabilities to their users can push EE and TK data to Rain via this API. Providers can also push data via CSV or API connector, though this documentation exclusively covers integration with RAIN's Data Ingestion API.
\nThe audience of this documentation is Backend and QA engineers from RAIN’s partners that will work on the integration, which entails getting Eligible Employee and Timekeeping data from their system and sending it to RAIN through this API.
\nAll the ingestion endpoints work asynchronously. This means that our system will process the submitted data in the background and send the processing status via webhooks.
\nThe high level view of the API can be seem in the diagram below:
\n![](\"https://lucid.app/publicSegments/view/c5a7d386-bd45-49fd-a7a2-761561ddf6df/image.png\")
\n\nFigure 1: Authentication overview diagram
\n![](\"https://lucid.app/publicSegments/view/26272112-0083-4464-978d-31985b4229ab/image.png\")
\n\nFigure 2: Ingestion overview diagram
\nThe RAIN's Workspace with the Data Ingestion API Collection is available here.
\nThis Collection includes a pre-configured environment. You will need to set up the following variables in order to run each request:
\nThe following are high level diagrams that show the data ingestion flow:
\n![](\"https://lucid.app/publicSegments/view/18f9d7f1-a527-49a4-9fbc-26092159c686/image.png\")
\n\n![](\"https://lucid.app/publicSegments/view/0d154dfb-cb7f-414d-959a-504b0176d806/image.png\")
\n\n![](\"https://lucid.app/publicSegments/view/465e060c-cd38-41bb-97f4-ab21e227bf33/image.png\")
\n\nTo provide safe and secure access to RAIN's API endpoints, TLS connections and mTLS authentication are required. All the endpoints also require an API key and OAuth2 authentication. This means that in order to use the Data Ingestion API, RAIN must grant credentials, keys, and certificates to the partner in advance.
\n![](\"https://www.cloudflare.com/resources/images/slt3lc6tev37/5SjaQfZzDLEGqyzFkA0AA4/d227a26bbd7bc6d24363e9b9aaabef55/how_mtls_works-what_is_mutual_tls.png\")
\n\nReference: What is mutual TLS (mTLS)?
\nRAIN provides a sandbox environment to be used by the client to validate the development and integration with RAIN's system.
This environment has settings similar to the production environment, which will be provided to the integrator after validation in the sandbox environment is completed.
This section is a list of practical guides on how to use our API including onboarding, authentication and using the main endpoints.
\nTo start using our API, you first need to get access to:
\n* API credentials and certificates
* Sandbox environment URL
In order for RAIN to provide access to the API, here is what you will need to provide to your RAIN technical contact:
\nHere are the specific items that your RAIN technical contact will provide you:
\n![](\"https://lucid.app/publicSegments/view/2c7317a5-f6fb-4ca0-bb02-0652e3e8dd27/image.png\")
\n\nFigure 3: Items exchange diagram
\nThe standard certificate duration we use is 1 year. Below is the explanation of how to obtain the certificate on different occasions.
\nThe first certificate will be sent manually and will be encrypted using the PGP public key provided to RAIN, as explained in the Section 2 above.
\nFrom the second certificate onwards, RAIN will send the new certificate using a webhook event. Below you can see an example of the payload:
\n{\n \"type\": \"CERTIFICATE_RENEWAL\",\n \"body\": {\n \"download_link_key\": \"https://url-download.com/client.key.gpg\",\n \"download_link_pem\": \"https://url-download.com/client.pem.gpg\"\n }\n}\n\nCheck the Topic Certificate Renewal Event for more details.
\nTo submit employer data to RAIN's Data Ingestion API, the client will need to use the Employer Ingestion endpoint.
\nThis endpoint allows clients to submit one single employer data per request. The response of each request will contain the result if the employer has been processed by RAIN's system.
\nThe client should submit all the employers before start sending the employees to be ingested. The field employer_code will be used to link an employer to its employees.
To retrieve employers ingested by RAIN's Data Ingestion API, the client will need to use the Employer retrieval endpoint.
\nThis endpoint allows clients to get all or one single employer per request. The response of each request will be a list containing the employers data ingested by RAIN's system.
\nTo update an employer ingested by RAIN's Data Ingestion API, the client will need to use the Employer update endpoint.
\nThis endpoint allows clients to update an employer name and status per request. The response of each request will contain the result if the employer has been updated by RAIN's system.
Remember to update the employer status to ACTIVE once it's ready to be listed to its employees on RAIN's system.
To submit employee data to RAIN's Data Ingestion API, the client will need to use the Employees Ingestion endpoint.
\nThis endpoint allows clients to submit a batch of employee data. The response of each request will be a batch_id which can be used to link the webhook event EMPLOYEE_BATCH_PROCESSED. After the batch has been processed by RAIN's system, the webhook processor will notify the client with the ingestion result. More details about the webhook event can be found in Topic Employee Event.
To submit employees' timekeeping data to RAIN's Data Ingestion API, the client will need to use the Timekeeping Ingestion endpoint.
\nThis endpoint allows clients to submit a batch of the employees' timekeeping data. The response of each request will be a batch_id which can be used to link the webhook event TIMEKEEPING_BATCH_PROCESSED. After the batch has been processed by RAIN's system, the webhook processor will notify the client with the ingestion result. More details about the webhook event can be found in Topic Timekeeping Event.
Considering the asynchronous processing, all the results of the processing operations will be communicated via webhook event.
\nTo be able to receive these events, the client must provide to RAIN an endpoint that accepts a POST request containing an API KEY in the header.
The request body content will have the event's details, wherein the client will be able to get the results of the asynchronous processing.
\nThe following request is an example of what RAIN will be sending to the client's webhook endpoint.
\ncurl --location --request POST 'api-client-example.com/webhook' \\\n--header 'x-api-key: valid-api-key' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"type\": \"EMPLOYEE_BATCH_PROCESSED\",\n \"body\": {\n \"batch_id\": \"uuid\",\n \"employer_code\": \"testeintimp\",\n \"employees\": [\n {\n \"employee_code\": \"70155dbc-480d-492d-9d58-4eaff1f5a31a\",\n \"status\": \"PROCESSED\"\n }\n ]\n }\n}\n'\n\nThe table below summarizes the fields for the events:
\nThe body.employees field contains all the processed status of each employee for a specific batch
{\n \"type\": \"EMPLOYEE_BATCH_PROCESSED\",\n \"body\": {\n \"batch_id\": \"uuid\",\n \"employer_code\": \"string\",\n \"employees\": [\n {\n \"employee_code\": \"70155dbc-480d-492d-9d58-4eaff1f5a31a\",\n \"status\": \"PROCESSED\"\n }\n ]\n }\n}\n\nThe body.timekeepings field contains the processed status of each timekeeping for a specific batch.
{\n \"type\": \"TIMEKEEPING_BATCH_PROCESSED\",\n \"body\": {\n \"batch_id\": \"uuid\",\n \"timekeepings\": [\n {\n \"timekeeping_code\": \"70155dbc-480d-492d-9d58-4eaff1f5a31a\",\n \"status\": \"PROCESSED\"\n }\n ]\n }\n}\n\nThe body.download_link_key and body.download_link_pem are temporary downloadable encrypted PGP files that contain the mTLS certificate key and pem file, respectively. These files must be sent in all requests in order to access RAIN's services.
{\n \"type\": \"CERTIFICATE_RENEWAL\",\n \"body\": {\n \"download_link_key\": \"https://url-download.com/client.key.gpg\",\n \"download_link_pem\": \"https://url-download.com/client.pem.gpg\"\n }\n}\n\nEach download link is going to contain an encrypted PGP file. Decrypt each of them with the PGP private key generated previously to get the file content.
\nTo help manage the amount of requests to RAIN's systems, limits are set on the number of requests that can be sent to the API. These limits are established to provide a reliable and scalable system.
\nIn order to use any of the API resources, it is required to send the TLS certificates along with the requests.
\nCurl Example:
\ncurl --key client.key --cert client.pem --location \\\n--request POST 'https://api.data-ingestion.rain.us/{{path}}'\n\nTo setup Postman certificate settings, follow these instructions.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"1. Key API Concepts","slug":"1-key-api-concepts"},{"content":"1.1. Glossary of Terms","slug":"11-glossary-of-terms"},{"content":"1.2. Data Flow Diagram","slug":"12-data-flow-diagram"},{"content":"1.3. Security Overview","slug":"13-security-overview"},{"content":"1.4. Development Process and Environments","slug":"14-development-process-and-environments"},{"content":"2. Getting Started","slug":"2-getting-started"},{"content":"2.1. Certificate Management","slug":"21-certificate-management"},{"content":"2.2. Submitting Employer Data","slug":"22-submitting-employer-data"},{"content":"2.3. Submitting Employee Data","slug":"23-submitting-employee-data"},{"content":"2.4. Submitting Timekeeping Data","slug":"24-submitting-timekeeping-data"},{"content":"2.5. Monitoring Webhooks Events","slug":"25-monitoring-webhooks-events"},{"content":"2.6. Event Types","slug":"26-event-types"},{"content":"2.7. API Rate Limit","slug":"27-api-rate-limit"},{"content":"3. Important","slug":"3-important"}],"owner":"19628595","collectionId":"c5b65ac5-9492-46ec-a168-24e5263548d0","publishedId":"Uz5NiDCE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3B4DCC"},"publishDate":"2022-06-10T20:22:40.000Z"},"item":[{"name":"Authentication","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"6aea3795-01ba-4595-a4ad-326184c71bda"}},{"listen":"test","script":{"exec":["var body = pm.response.json();","pm.environment.set(\"access_token\", body.access_token);"],"type":"text/javascript","id":"e0527da5-b7f3-42ec-9aee-47c84cea1396"}}],"id":"17440dfd-fc72-4ea2-8d25-5593509d782c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"{{client_id}}","password":"{{client_secret}}"},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{x_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"scope\": \"{{scope}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/oauth2/token","description":"\n\nTo perform this request it is necessary to attach the TLS certificates as described here.
\n
Use the Authentication endpoint to retrieve the JWT Token in order to access the other resources.
\n","urlObject":{"path":["oauth2","token"],"host":["{{api_url}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"19669057-daca-4297-aeb9-cafb71628032","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{x_api_key}}","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"scope\": {{scope}}\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/oauth2/token"},"code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"access_token\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}"},{"id":"808e8ed7-dea0-4d98-86ba-4f14729f8c3a","name":"400 Invalid credentials","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{x_api_key}}","type":"text"},{"key":"Authorization","value":"Basic ...invalid_token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"scope\": {{scope}}\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\"\n}"},{"id":"9b2dcc0a-54da-4c06-ad8e-3ff28a3b4870","name":"400 Missing scope","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{x_api_key}}","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"scope\": {{scope}}\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"missing_scope\"\n}"}],"_postman_id":"17440dfd-fc72-4ea2-8d25-5593509d782c"},{"name":"Employees ingestion","id":"bc00be52-1962-4254-a071-459e68548111","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{x_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employees\": [\n {\n \"employee_code\": \"EE001\",\n \"employer_code\": \"testeintimp\",\n \"group_code\": \"testeintimp\",\n \"status\": \"ACTIVE\",\n \"wage_type\": \"HOURLY\",\n \"pay_frequency\": \"BI_WEEKLY\",\n \"pay_rate\": 10,\n \"pay_cycle\": {\n \"start_date\": \"2022-06-05\",\n \"end_date\": \"2022-06-20\"\n },\n \"first_name\": \"Harmony\",\n \"last_name\": \"FakeTestzz\",\n \"email\": \"emery@rippin.info\",\n \"phone_number\": \"1-225-450-2584\"\n },\n {\n \"employee_code\": \"EE002\",\n \"employer_code\": \"testeintimp\",\n \"group_code\": \"testeintimp\",\n \"status\": \"ACTIVE\",\n \"wage_type\": \"SALARY\",\n \"pay_frequency\": \"BI_WEEKLY\",\n \"pay_rate\": 10,\n \"pay_cycle\": {\n \"start_date\": \"2022-06-05\",\n \"end_date\": \"2022-06-20\"\n },\n \"first_name\": \"Isiah\",\n \"last_name\": \"FakeTestzz\",\n \"email\": \"sophia.franecki@hartmann-wintheiser.biz\",\n \"phone_number\": \"400.951.4168\"\n },\n {\n \"employee_code\": \"EE003\",\n \"employer_code\": \"testeintimp\",\n \"group_code\": \"testeintimp\",\n \"status\": \"ACTIVE\",\n \"wage_type\": \"SALARY\",\n \"pay_frequency\": \"BI_WEEKLY\",\n \"pay_rate\": 10,\n \"pay_cycle\": {\n \"start_date\": \"2022-06-05\",\n \"end_date\": \"2022-06-20\"\n },\n \"first_name\": \"Madelene\",\n \"last_name\": \"FakeTestzz\",\n \"email\": \"dorinda_rutherford@williamson-parisian.name\",\n \"phone_number\": \"1-451-539-7684\"\n },\n {\n \"employee_code\": \"EE004\",\n \"employer_code\": \"testeintimp\",\n \"group_code\": \"testeintimp\",\n \"status\": \"ACTIVE\",\n \"wage_type\": \"HOURLY\",\n \"pay_frequency\": \"BI_WEEKLY\",\n \"pay_rate\": 10,\n \"pay_cycle\": {\n \"start_date\": \"2022-06-05\",\n \"end_date\": \"2022-06-20\"\n },\n \"first_name\": \"Wilfredo\",\n \"last_name\": \"FakeTestzz\",\n \"email\": \"helene.gusikowski@kunze.biz\",\n \"phone_number\": \"1-101-596-1054\"\n },\n {\n \"employee_code\": \"EE005\",\n \"employer_code\": \"testeintimp\",\n \"group_code\": \"testeintimp\",\n \"status\": \"ACTIVE\",\n \"wage_type\": \"SALARY\",\n \"pay_frequency\": \"BI_WEEKLY\",\n \"pay_rate\": 10,\n \"pay_cycle\": {\n \"start_date\": \"2022-06-05\",\n \"end_date\": \"2022-06-20\"\n },\n \"first_name\": \"Freddy\",\n \"last_name\": \"FakeTestzz\",\n \"email\": \"loree_kulas@cremin.io\",\n \"phone_number\": \"(587) 720-0865\"\n },\n {\n \"employee_code\": \"EE006\",\n \"employer_code\": \"testeintimp\",\n \"group_code\": \"testeintimp\",\n \"status\": \"INACTIVE\",\n \"wage_type\": \"SALARY\",\n \"pay_frequency\": \"BI_WEEKLY\",\n \"pay_rate\": 10,\n \"pay_cycle\": {\n \"start_date\": \"2022-06-05\",\n \"end_date\": \"2022-06-20\"\n },\n \"first_name\": \"Felipe\",\n \"last_name\": \"FakeTestzz\",\n \"email\": \"benny.ritchie@moen.net\",\n \"phone_number\": \"(483) 766-3129\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/employees","description":"\n\nTo perform this request it is necessary to attach the TLS certificates as described here.
\n
This endpoint allows the client to submit employee data. If new data is submitted for an existing employee_code , that employee’s data will be updated. If an employee_code is not present in RAIN’s system, that employee’s data will be ingested.
The request payload size must not be larger than 3 MB.
\nBody
\nEmployee
\nThe first_name, last_name, email and phone_number fields are optional, however, for them to work as optional it requires a specific configuration from RAIN.
So this need to be informed during onboarding, otherwise the employees data sent won't be successfully processed.
The fields pay_cycle.start_date, pay_cycle.end_date, and pay_frequency are also optional, but if one of them is sent the others also need to be sent. It is preferred that these fields are sent, however, if they aren't, a default value will be automatically calculated and set for them.
\n\nTo perform this request it is necessary to attach the TLS certificates as described here.
\n
This endpoint allows the client to submit employees' timekeeping to be ingested by RAIN's system.
\nThe request payload size must not be larger than 3 MB.
\nBody
\nTimekeeping
\n","urlObject":{"path":["timekeepings"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"2fc9d1ca-6387-45dc-a3fc-883bf8e7f515","name":"200 Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"timekeepings\": [\n {\n \"timekeeping_code\": \"4567\",\n \"employee_code\": \"1234\",\n \"worked_hours\": 8.0,\n \"work_date\": \" 2022-04-02\",\n \"earned_wage\": 160.0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/timekeepings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"batch_id\": \"2854b0db-b1de-4739-99c4-e1337a1b7e83\"\n}"},{"id":"b9aeb6ac-35be-4f04-acc1-6a17f415baef","name":"429 Rate Limit Exceeded","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"x-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"timekeepings\": [\n {\n \"timekeeping_code\": \"4567\",\n \"employee_code\": \"1234\",\n \"worked_hours\": 8.0,\n \"work_date\": \" 2022-04-02\",\n \"earned_wage\": 160.0\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/timekeepings"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"Rate Limit Exceeded!"},{"id":"083f8f63-0c10-417a-b46d-2c63261e9e23","name":"400 Bad Request - Too many timekeepings","originalRequest":{"method":"POST","header":[{"key":"","name":"Content-Type","value":"","type":"text","disabled":true},{"key":"Content-Type","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n \"timekeepings\": [\n // More than 10000 timekeepings\n //...\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/timekeepings"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"timekeepings\": [\n \"Array length must be between 1 and 10000.\"\n ]\n }\n}"},{"id":"3cce7998-3205-473e-b53f-193bbec774aa","name":"400 Bad Request - Invalid Data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"timekeepings\": [\r\n {\r\n \"timekeeping_code\": \"\",\r\n \"employee_code\": \"1234\",\r\n \"worked_hours\": \"8.0\",\r\n \"work_date\": \" 2022-13-02\",\r\n \"unknown_field\": 160.0\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/timekeepings"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"timekeepings\": {\n \"0\": { \n \"worked_hours\": [\n \"Value is not a valid number.\"\n ],\n \"work_date\": [\n \"Value is not a valid date, must to be 'yyyy-MM-dd' format.\"\n ], \n \"earned_wage\": [\n \"Missing data for required field.\"\n ],\n \"unknown_field\": [\n \"Unknown field.\"\n ]\n }\n }\n }\n}"}],"_postman_id":"4492fca9-f137-4a1d-a5ee-d7cca9ff811f"},{"name":"Employers ingestion","id":"99d7d41e-8f1d-4c51-973b-b7d8ecb7a4f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{x_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"employer_code\":\"ABCD\",\r\n \"name\": \"EmployerTest\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/employers","description":"\n\nTo perform this request it is necessary to attach the TLS certificates as described here.
\n
This endpoint allows the client to submit employers to be ingested by RAIN's system. If there is an attempt of ingest a new employer with the same employer_code or name of an employer that was already ingested, an error will be returned. In order to update an existing employer, use the PUT endpoint.
\n\nTo perform this request it is necessary to attach the TLS certificates as described here.
\n
This endpoint allows the client to retrieve the employers ingested by RAIN's system. In order to insert new employers, use the POST endpoint.
If no query params is specified, all the employers will be returned.
\n","urlObject":{"path":["employers"],"host":["{{api_url}}"],"query":[{"disabled":true,"description":{"content":"Unique ID for the employer on the client side
\n","type":"text/plain"},"key":"employer_code","value":"{employer_code}"}],"variable":[]}},"response":[{"id":"e6016ba9-59ae-4feb-bcd4-cf0e0ed9e3b3","name":"200 Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"x-api-key","type":"text"}],"url":{"raw":"{{api_url}}/employers","host":["{{api_url}}"],"path":["employers"],"query":[{"key":"employer_code","value":"{employer_code}","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"employers\": [\n {\n \"name\": \"EmployerTest\",\n \"employer_code\": \"employertest\",\n \"status\": \"INACTIVE\",\n \"created_at\": \"2022-07-01T18:04:46.002000+00:00\",\n \"updated_at\": \"2022-07-01T18:04:46.002000+00:00\"\n }\n ]\n}"},{"id":"bf9cd6fa-0563-432d-ae04-4882c16f9edc","name":"429 Rate Limit Exceeded","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"x-api-key","type":"text"}],"url":{"raw":"{{api_url}}/employers","host":["{{api_url}}"],"path":["employers"],"query":[{"key":"employer_code","value":"{employer_code}","type":"text","disabled":true}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"Rate Limit Exceeded!"},{"id":"bf26c6e4-4a14-4ab1-9f5d-de78b6909298","name":"400 Bad Request - Invalid parameter","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"x-api-key","type":"text"}],"url":{"raw":"{{api_url}}/employers?employer_code","host":["{{api_url}}"],"path":["employers"],"query":[{"key":"employer_code","value":null}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"employer_code\": [\n \"Value should not be empty.\"\n ]\n }\n}"}],"_postman_id":"f6945fe9-299e-472c-9a7d-10cf7ff8c1d5"},{"name":"Employer update","id":"0d8ded45-e332-405a-acef-2d513b7ea575","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PUT","header":[{"key":"x-api-key","value":"{{x_api_key}}","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"name\": \"EmployerTest\",\r\n \"status\": \"ACTIVE\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/employers/:employer_code","description":"\n\nTo perform this request it is necessary to attach the TLS certificates as described here.
\n
This endpoint allows the client to update employer's name and status. If there is an attempt of update an employer with the same name of an employer that was already ingested, an error will be returned.
Remember to update the employer status to ACTIVE once it's ready to be listed to its employees on RAIN's system.
Unique ID for the employer on the client side
\n","type":"text/plain"},"type":"any","value":"","key":"employer_code"}]}},"response":[{"id":"ae847963-fef5-451f-9485-6cc35721310d","name":"200 Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"x-api-key","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"name\": \"EmployerTest\",\r\n \"status\": \"ACTIVE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/employers/:employer_code","host":["{{api_url}}"],"path":["employers",":employer_code"],"variable":[{"key":"employer_code","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Employer updated.\"\n}"},{"id":"8f57969a-f17b-4108-b019-70d88d1e1b1a","name":"429 Rate Limit Exceeded","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"x-api-key","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"name\": \"EmployerTest\",\r\n \"status\": \"ACTIVE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/employers/:employer_code","host":["{{api_url}}"],"path":["employers",":employer_code"],"variable":[{"key":"employer_code","value":null}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"Rate Limit Exceeded!"},{"id":"4bc5d829-69b1-4a78-8fcd-be85625c2dd0","name":"400 Bad Request - Invalid Data","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"x-api-key","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"name\": \"\",\r\n \"status\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/employers/:employer_code","host":["{{api_url}}"],"path":["employers",":employer_code"],"variable":[{"key":"employer_code","value":null}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": [\n \"Value should not be empty.\"\n ],\n \"status\": [\n \"Value should not be empty.\"\n ]\n }\n}"},{"id":"f39265b0-617c-4c94-a68c-ec2b5f6d61ff","name":"400 Bad Request - Employer name already exists","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"x-api-key","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"name\": \"EmployerTest\",\r\n \"status\": \"ACTIVE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/employers/:employer_code","host":["{{api_url}}"],"path":["employers",":employer_code"],"variable":[{"key":"employer_code","value":null}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Employer with this name already exists.\"\n}"},{"id":"3168f166-5988-4d88-8341-97bc264dcc60","name":"404 Not found - Employer not found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"x-api-key","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"name\": \"EmployerTest\",\r\n \"status\": \"ACTIVE\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/employers/:employer_code","host":["{{api_url}}"],"path":["employers",":employer_code"],"variable":[{"key":"employer_code","value":null}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Employer not found.\"\n}"}],"_postman_id":"0d8ded45-e332-405a-acef-2d513b7ea575"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1cfe473e-6847-4df0-8605-9e2c584520b5"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"19a951b4-7dab-48ec-94a6-2981cb9cab8b"}}]}