{ "info": { "_postman_id": "b74bb06a-411a-4fe8-85d9-5fa19a205caa", "name": "Remote Address Details Compliance API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:45:10.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "lastUpdatedBy": "35240", "uid": "35240-b74bb06a-411a-4fe8-85d9-5fa19a205caa" }, "item": [ { "name": "v1", "item": [ { "name": "companies", "item": [ { "name": "{company_id}", "item": [ { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "onboarding-reserves-status", "item": [ { "name": "Get Onboarding Reserves Status for Employment", "id": "68bb07b3-2810-4aed-817f-fa96f0709e67", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company_department:read webhook:write magic_link:write offboarding:write custom_field:write address:write expense:read employment:write identity_verification:write timesheet:write travel_letter:write incentive:read personal_detail:read invoices:write work_authorization:write timeoff:write company_structure:read benefit_renewal:write benefit_offer:read employment_documents onboarding:write payroll_run:read risk_reserve:write invoices resignation_letter:read resignation:read convert_currency:read employments probation_document:read company_admin payroll help_center_article:read timesheet:read custom_field_value:write company_currencies:read payslip:read pay_item:write resignation:write custom_field:read payroll_calendar:read contract_amendment:write offboarding:read timeoff:read probation_document:write country:read webhook:read company_department:write company_manager:read pay_item:read contract_amendment:read company:read sso_configuration:write benefit_offer:write contract_eligibility:write benefit_renewal:read background_check:read custom_field_value:read expense:write identity_verification:read address:read document:write time_and_attendance employment_payments form:read work_authorization:read invoices:read incentive:write employment:read contract:read company_manager:write travel_letter:read document:read sso_configuration:read", "type": "string" }, { "key": "redirect_uri", "value": "/auth/oauth2/token", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "/auth/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "id": "03261ac4-cc2a-493a-b5bb-c482ffbf7f41", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "19354103-b312-47e8-8da9-f88b1e92b8c9", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns the onboarding reserves status for a specific employment.\n\nThe status is the same as the credit risk status but takes the onboarding reserves policies into account.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "851f0af2-7b6d-4a93-9507-14af2405d32f", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "key": "company_id" }, { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"deposit_required\",\n \"policies\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-851f0af2-7b6d-4a93-9507-14af2405d32f" }, { "id": "6a7aa4b8-be79-4511-8483-57b6db8f0800", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "key": "company_id" }, { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-6a7aa4b8-be79-4511-8483-57b6db8f0800" }, { "id": "cb29a8ca-df33-4a01-921d-092694280f06", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "key": "company_id" }, { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-cb29a8ca-df33-4a01-921d-092694280f06" }, { "id": "a2e402d9-a558-4246-9368-45616216d94c", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "key": "company_id" }, { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-a2e402d9-a558-4246-9368-45616216d94c" } ], "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-68bb07b3-2810-4aed-817f-fa96f0709e67" } ], "id": "6af7fca2-f134-4dcc-8c43-17d1968c635d", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-6af7fca2-f134-4dcc-8c43-17d1968c635d" } ], "id": "784afb5c-4cde-40bc-b209-718ca2973db0", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-784afb5c-4cde-40bc-b209-718ca2973db0" } ], "id": "5f616ccb-17a8-49da-80aa-40e943d44fe9", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-5f616ccb-17a8-49da-80aa-40e943d44fe9" }, { "name": "compliance-profile", "item": [ { "name": "Get Company Compliance Profile", "id": "004b7672-f6cf-4dac-afb9-84766ff9d2eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company_department:read webhook:write magic_link:write offboarding:write custom_field:write address:write expense:read employment:write identity_verification:write timesheet:write travel_letter:write incentive:read personal_detail:read invoices:write work_authorization:write timeoff:write company_structure:read benefit_renewal:write benefit_offer:read employment_documents onboarding:write payroll_run:read risk_reserve:write invoices resignation_letter:read resignation:read convert_currency:read employments probation_document:read company_admin payroll help_center_article:read timesheet:read custom_field_value:write company_currencies:read payslip:read pay_item:write resignation:write custom_field:read payroll_calendar:read contract_amendment:write offboarding:read timeoff:read probation_document:write country:read webhook:read company_department:write company_manager:read pay_item:read contract_amendment:read company:read sso_configuration:write benefit_offer:write contract_eligibility:write benefit_renewal:read background_check:read custom_field_value:read expense:write identity_verification:read address:read document:write time_and_attendance employment_payments form:read work_authorization:read invoices:read incentive:write employment:read contract:read company_manager:write travel_letter:read document:read sso_configuration:read", "type": "string" }, { "key": "redirect_uri", "value": "/auth/oauth2/token", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "/auth/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "id": "df5211e3-e44b-4663-bdc3-851e056eb27c", "key": "company_id", "value": "", "description": "(Required) Company ID" } ] }, "description": "Returns the KYB and credit risk status for the company's default legal entity.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) |\n" }, "response": [ { "id": "1f6d254e-3f21-418c-8f59-977f741b279d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "key": "company_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"compliance_profile\": {\n \"kyb_status\": \"not_started\",\n \"credit_risk_status\": \"ready\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-1f6d254e-3f21-418c-8f59-977f741b279d" }, { "id": "9e742331-a9c4-4b7e-a213-e5245cd6b162", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-9e742331-a9c4-4b7e-a213-e5245cd6b162" }, { "id": "c5022eb3-3ee7-4099-8952-0c0e82d59a7e", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "key": "company_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-c5022eb3-3ee7-4099-8952-0c0e82d59a7e" }, { "id": "5bd25240-4e3c-4409-9e3e-dc333948fa03", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "key": "company_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-5bd25240-4e3c-4409-9e3e-dc333948fa03" } ], "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-004b7672-f6cf-4dac-afb9-84766ff9d2eb" } ], "id": "610ee5a3-5c52-44c2-b452-760da10e6654", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-610ee5a3-5c52-44c2-b452-760da10e6654" } ], "id": "2db532e3-912f-46f4-88a6-862b153a657a", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-2db532e3-912f-46f4-88a6-862b153a657a" } ], "id": "4fb98ef2-678a-4849-a619-eff607b6df2b", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-4fb98ef2-678a-4849-a619-eff607b6df2b" } ], "id": "a452d459-162b-4251-8ede-adfc99936460", "createdAt": "2026-07-28T02:45:11.000Z", "updatedAt": "2026-07-28T02:45:11.000Z", "uid": "35240-a452d459-162b-4251-8ede-adfc99936460" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company_department:read webhook:write magic_link:write offboarding:write custom_field:write address:write expense:read employment:write identity_verification:write timesheet:write travel_letter:write incentive:read personal_detail:read invoices:write work_authorization:write timeoff:write company_structure:read benefit_renewal:write benefit_offer:read employment_documents onboarding:write payroll_run:read risk_reserve:write invoices resignation_letter:read resignation:read convert_currency:read employments probation_document:read company_admin payroll help_center_article:read timesheet:read custom_field_value:write company_currencies:read payslip:read pay_item:write resignation:write custom_field:read payroll_calendar:read contract_amendment:write offboarding:read timeoff:read probation_document:write country:read webhook:read company_department:write company_manager:read pay_item:read contract_amendment:read company:read sso_configuration:write benefit_offer:write contract_eligibility:write benefit_renewal:read background_check:read custom_field_value:read expense:write identity_verification:read address:read document:write time_and_attendance employment_payments form:read work_authorization:read invoices:read incentive:write employment:read contract:read company_manager:write travel_letter:read document:read sso_configuration:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "/auth/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://gateway.remote.com/" } ] }