{ "info": { "_postman_id": "77b4d008-b7d7-40e3-b4de-6cc175cfb9ee", "name": "Iron API - Sandbox Addresses Customer API", "description": "The Stablecoin Payment Network", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "lastUpdatedBy": "35240", "uid": "35240-77b4d008-b7d7-40e3-b4de-6cc175cfb9ee" }, "item": [ { "name": "authentication-codes", "item": [ { "name": "entity", "item": [ { "name": "{id}", "item": [ { "name": "Get the pending authentication code for an entity", "id": "e00ea645-f1df-44b4-a832-70e8ac9d5ecc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/authentication-codes/entity/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", "entity", ":id" ], "variable": [ { "id": "5d7963ac-fd66-498c-8ad2-8be4418555f3", "key": "id", "value": "", "description": "(Required) The ID of the entity to get the pending authentication code for" } ] }, "description": "Get the pending authentication code for an entity by ID\ne.g. ID of Autoramp or FiatAddress (entity in AuhorizationRequired state)\nif no pending code is found, retry flow will have to be triggered\n" }, "response": [ { "id": "77b2f0f3-3df7-434a-9c0d-569741f322fd", "name": "GET Authentication Code Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/authentication-codes/entity/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", "entity", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"Expired\",\n \"expires_at\": \"\",\n \"attempts\": \"\",\n \"entity_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-77b2f0f3-3df7-434a-9c0d-569741f322fd" }, { "id": "b7b0cbdd-7f2e-4b14-8ddf-1891ec59ed2c", "name": "GET Authentication Code Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/authentication-codes/entity/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", "entity", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-b7b0cbdd-7f2e-4b14-8ddf-1891ec59ed2c" }, { "id": "a582208a-d077-4328-8f7c-32399533e5fa", "name": "GET Authentication Code Failed (Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/authentication-codes/entity/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", "entity", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-a582208a-d077-4328-8f7c-32399533e5fa" }, { "id": "0f1f590c-8c73-423a-934e-b29f452d4563", "name": "GET Authentication Code Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/authentication-codes/entity/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", "entity", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-0f1f590c-8c73-423a-934e-b29f452d4563" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-e00ea645-f1df-44b4-a832-70e8ac9d5ecc" } ], "id": "ce73bbe5-864f-4033-97df-fb9c16540c89", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-ce73bbe5-864f-4033-97df-fb9c16540c89" } ], "id": "73477514-7b92-4965-bd30-31ba6f591523", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-73477514-7b92-4965-bd30-31ba6f591523" }, { "name": "{id}", "item": [ { "name": "Submit an authentication code", "id": "3eab2012-1964-450f-bb4c-12bfe74326b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be submitted under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/authentication-codes/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", ":id" ], "variable": [ { "id": "6c6610c7-4223-4cf2-8cae-f86a553de290", "key": "id", "value": "", "description": "(Required) The ID of the authentication code to submit" } ] }, "description": "Submit the code for a given authentication\n" }, "response": [ { "id": "1940cd12-a024-40e9-9c70-5f948cb303fe", "name": "PUT Authentication Code Succeeded", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be submitted under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/authentication-codes/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"Expired\",\n \"expires_at\": \"\",\n \"attempts\": \"\",\n \"entity_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-1940cd12-a024-40e9-9c70-5f948cb303fe" }, { "id": "490334ac-c94a-4cc3-97b0-d2dd384d88b2", "name": "PUT Authentication Code Failed (Unauthorized)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be submitted under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/authentication-codes/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-490334ac-c94a-4cc3-97b0-d2dd384d88b2" }, { "id": "db610227-045e-449a-883f-7b8eb4cdab4b", "name": "PUT Authentication Code Failed (Not Found)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be submitted under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/authentication-codes/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-db610227-045e-449a-883f-7b8eb4cdab4b" }, { "id": "5de172a4-4097-4fa5-aa57-e81afc286b80", "name": "PUT Authentication Code Failed (Internal Error)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the authentication code will be submitted under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/authentication-codes/:id", "host": [ "{{baseUrl}}" ], "path": [ "authentication-codes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-5de172a4-4097-4fa5-aa57-e81afc286b80" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-3eab2012-1964-450f-bb4c-12bfe74326b7" } ], "id": "b2a10edf-ae54-4689-90b9-2a247fd674e6", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-b2a10edf-ae54-4689-90b9-2a247fd674e6" } ], "id": "e6011597-f9aa-4296-919d-bcabb24df9c3", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-e6011597-f9aa-4296-919d-bcabb24df9c3" }, { "name": "customers", "item": [ { "name": "{external_id}", "item": [ { "name": "external", "item": [ { "name": "Get a customer by external ID", "id": "36384204-a99e-4b82-bbc2-0b1dd3b922d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:external_id/external", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":external_id", "external" ], "variable": [ { "id": "b8fa737a-4230-42fc-9df7-3c6666aadd86", "key": "external_id", "value": "", "description": "(Required) the external ID of the Customer to GET" } ] }, "description": "Retrieve a specific customer by external ID\n" }, "response": [ { "id": "2cc94f2b-dbfb-4f81-a8fe-362b9076c984", "name": "GET Customer Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:external_id/external", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":external_id", "external" ], "variable": [ { "key": "external_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"customer_type\": \"Person\",\n \"identification_ids\": [\n \"\",\n \"\"\n ],\n \"signing_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"Active\",\n \"name\": \"\",\n \"email\": \"\",\n \"partner_id\": \"\",\n \"active_email\": \"\",\n \"external_id\": \"\",\n \"identification_status\": \"Approved\",\n \"spending_limit_euro\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-2cc94f2b-dbfb-4f81-a8fe-362b9076c984" }, { "id": "6be27f19-d511-42a6-a530-869dc128ef27", "name": "GET Customer Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:external_id/external", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":external_id", "external" ], "variable": [ { "key": "external_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-6be27f19-d511-42a6-a530-869dc128ef27" }, { "id": "428dd361-e972-4f04-9e84-437e7add1ec2", "name": "GET Customer Failed (Resource Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:external_id/external", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":external_id", "external" ], "variable": [ { "key": "external_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-428dd361-e972-4f04-9e84-437e7add1ec2" }, { "id": "2ad547ce-874c-4888-ab1d-76a05d8051ed", "name": "GET Customer Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:external_id/external", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":external_id", "external" ], "variable": [ { "key": "external_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-2ad547ce-874c-4888-ab1d-76a05d8051ed" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-36384204-a99e-4b82-bbc2-0b1dd3b922d2" } ], "id": "2244aed8-27da-459b-8dfb-e27700a9e1cb", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-2244aed8-27da-459b-8dfb-e27700a9e1cb" } ], "id": "13f4be42-f876-4f47-a299-dc3f557d0026", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-13f4be42-f876-4f47-a299-dc3f557d0026" }, { "name": "{id}", "item": [ { "name": "abilities", "item": [ { "name": "Get customer abilities", "id": "2da2c404-448a-463e-aec0-5cabacb2568f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:id/abilities", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "abilities" ], "variable": [ { "id": "c97ebc6f-449f-41a6-9019-707bfb71b1a2", "key": "id", "value": "", "description": "(Required) the ID of the Customer to GET abilities for" } ] }, "description": "Retrieve the abilities/capabilities for a specific customer by ID\n" }, "response": [ { "id": "f021299f-c243-4d4e-b283-e5a287e7e451", "name": "GET Customer Abilities Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/abilities", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "abilities" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"fiat_deposit\": {\n \"eur\": {\n \"sepa\": \"Maintenance\",\n \"sepa_thirdparty\": \"Active\",\n \"swift\": \"Active\",\n \"swift_thirdparty\": \"Blocked\"\n },\n \"gbp\": {\n \"fps\": \"Maintenance\",\n \"fps_thirdparty\": \"Active\",\n \"chaps\": \"Maintenance\",\n \"chaps_thirdparty\": \"Maintenance\",\n \"swift\": \"Maintenance\",\n \"swift_thirdparty\": \"Pending\"\n },\n \"usd\": {\n \"ach\": \"Maintenance\",\n \"ach_thirdparty\": \"Blocked\",\n \"wire\": \"Active\",\n \"wire_thirdparty\": \"Active\",\n \"swift\": \"Maintenance\",\n \"swift_thirdparty\": \"Active\",\n \"rtp\": \"Unavailable\",\n \"rtp_thirdparty\": \"Maintenance\",\n \"fednow\": \"Unavailable\",\n \"fednow_thirdparty\": \"Blocked\"\n }\n },\n \"fiat_payout\": {\n \"eur\": {\n \"sepa\": \"Unavailable\",\n \"sepa_thirdparty\": \"Unavailable\",\n \"swift\": \"Maintenance\",\n \"swift_thirdparty\": \"Unavailable\"\n },\n \"gbp\": {\n \"fps\": \"Pending\",\n \"fps_thirdparty\": \"Active\",\n \"chaps\": \"Unavailable\",\n \"chaps_thirdparty\": \"Pending\",\n \"swift\": \"Maintenance\",\n \"swift_thirdparty\": \"Pending\"\n },\n \"usd\": {\n \"ach\": \"Maintenance\",\n \"ach_thirdparty\": \"Maintenance\",\n \"wire\": \"Active\",\n \"wire_thirdparty\": \"Blocked\",\n \"swift\": \"Unavailable\",\n \"swift_thirdparty\": \"Unavailable\",\n \"rtp\": \"Blocked\",\n \"rtp_thirdparty\": \"Maintenance\",\n \"fednow\": \"Maintenance\",\n \"fednow_thirdparty\": \"Maintenance\"\n }\n },\n \"currencies\": [\n {\n \"currency\": {\n \"blockchain\": \"Stellar\",\n \"token\": \"\",\n \"type\": \"Crypto\"\n },\n \"flows\": [\n \"Offramp\",\n \"Onramp\"\n ],\n \"counterparts\": [\n {\n \"blockchain\": \"Stellar\",\n \"token\": \"\",\n \"type\": \"Crypto\"\n },\n {\n \"blockchain\": \"Tron\",\n \"token\": \"\",\n \"type\": \"Crypto\"\n }\n ]\n },\n {\n \"currency\": {\n \"blockchain\": \"Avalanche\",\n \"token\": \"\",\n \"type\": \"Crypto\"\n },\n \"flows\": [\n \"Onramp\",\n \"Redeem\"\n ],\n \"counterparts\": [\n {\n \"blockchain\": \"Tron\",\n \"token\": \"\",\n \"type\": \"Crypto\"\n },\n {\n \"blockchain\": \"Arbitrum\",\n \"token\": \"\",\n \"type\": \"Crypto\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f021299f-c243-4d4e-b283-e5a287e7e451" }, { "id": "c4761ec2-f2ab-47da-8b2a-cd5e88eda7d1", "name": "GET Customer Abilities Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/abilities", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "abilities" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-c4761ec2-f2ab-47da-8b2a-cd5e88eda7d1" }, { "id": "7b7d6af6-1fbe-4f15-ad77-e8b31acca139", "name": "GET Customer Abilities Failed (Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/abilities", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "abilities" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-7b7d6af6-1fbe-4f15-ad77-e8b31acca139" }, { "id": "f02800dc-5efa-4b1a-baaa-28b3d9efd92f", "name": "GET Customer Abilities Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/abilities", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "abilities" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f02800dc-5efa-4b1a-baaa-28b3d9efd92f" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-2da2c404-448a-463e-aec0-5cabacb2568f" } ], "id": "1595ed2b-f564-4f10-a881-268704d4a871", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-1595ed2b-f564-4f10-a881-268704d4a871" }, { "name": "archive", "item": [ { "name": "Archive a customer", "id": "83bfa88e-1a51-4b5a-ae84-28f23882d32c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "archive" ], "variable": [ { "id": "4157cd79-862d-4bcf-b33d-d05a17470326", "key": "id", "value": "", "description": "(Required) the ID of the Customer to archive" } ] }, "description": "Archive a customer and all of their identifications. This is terminal and\ncannot be undone: the customer is completely and permanently blocked from\nusing any services.\n" }, "response": [ { "id": "ab2fc7c5-8aeb-47f5-b115-3e50c3ac6038", "name": "Customer Archived", "originalRequest": { "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "archive" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"customer_type\": \"Person\",\n \"identification_ids\": [\n \"\",\n \"\"\n ],\n \"signing_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"Active\",\n \"name\": \"\",\n \"email\": \"\",\n \"partner_id\": \"\",\n \"active_email\": \"\",\n \"external_id\": \"\",\n \"identification_status\": \"Approved\",\n \"spending_limit_euro\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-ab2fc7c5-8aeb-47f5-b115-3e50c3ac6038" }, { "id": "d5e1b590-e1c5-42d6-84cb-9b20b01920ca", "name": "Archive Customer Failed (Bad Request)", "originalRequest": { "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "archive" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-d5e1b590-e1c5-42d6-84cb-9b20b01920ca" }, { "id": "a4b92081-0334-4abe-8324-6aac523b96c4", "name": "Archive Customer Failed (Unauthorized)", "originalRequest": { "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "archive" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-a4b92081-0334-4abe-8324-6aac523b96c4" }, { "id": "7e263c23-b0ab-47e6-ac5a-398e336191b1", "name": "Archive Customer Failed (Internal Error)", "originalRequest": { "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "archive" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-7e263c23-b0ab-47e6-ac5a-398e336191b1" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-83bfa88e-1a51-4b5a-ae84-28f23882d32c" } ], "id": "1f29c089-6c22-4c15-888f-410a60ab5ff6", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-1f29c089-6c22-4c15-888f-410a60ab5ff6" }, { "name": "identifications", "item": [ { "name": "v2", "item": [ { "name": "Create Customer Identification V2", "id": "040bea49-b40b-4900-8eb5-9f591101f971", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer Identification operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Link\",\n \"with_edd\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/identifications/v2", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications", "v2" ], "variable": [ { "id": "ec7cf559-0b02-4a5f-ab3a-5619ce76e33d", "key": "id", "value": "", "description": "(Required) the ID of the Customer to create an Identification for" } ] }, "description": "This will create a new identification for the customer, dependent on the customer type a KYC or KYB will be created for the customer to complete.\nwe support three types of identification:\n- Link: where a link is provided to the customer for access to the identification process.\n- Token: where a token is provided in the request from which verification data can be extracted and where the token is generated by the third party provider\n- Person: where the identification details of the person for which the identification process is being created are provided in the request" }, "response": [ { "id": "8668de5b-87e0-43b4-a9b5-2d7f565c38c3", "name": "POST Customer Identification Succeeded", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer Identification operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Link\",\n \"with_edd\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/identifications/v2", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications", "v2" ], "variable": [ { "key": "id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"Declined\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"partner_id\": \"\",\n \"residence_country\": \"\",\n \"review_comment\": \"\",\n \"step_status\": {\n \"company_beneficiaries\": {\n \"result\": \"Declined\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_data\": {\n \"result\": \"Processed\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_documents\": {\n \"result\": \"Archived\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"questionnaire\": {\n \"result\": \"PendingReview\",\n \"retry\": \"\",\n \"comment\": \"\"\n }\n },\n \"url\": \"\",\n \"with_edd\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-8668de5b-87e0-43b4-a9b5-2d7f565c38c3" }, { "id": "e8985101-5146-46a2-8eec-43ae2f45dc45", "name": "POST Customer Identification Failed (Invalid Request)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer Identification operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Link\",\n \"with_edd\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/identifications/v2", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications", "v2" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-e8985101-5146-46a2-8eec-43ae2f45dc45" }, { "id": "fa7bc7d2-2216-4f90-8d6c-e76683b0f953", "name": "POST Customer Identification Failed (Unauthorized)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer Identification operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Link\",\n \"with_edd\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/identifications/v2", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications", "v2" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-fa7bc7d2-2216-4f90-8d6c-e76683b0f953" }, { "id": "1623793d-c507-48aa-9aa7-dc1427df9a1b", "name": "POST Customer Identification Failed (Forbidden)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer Identification operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Link\",\n \"with_edd\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/identifications/v2", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications", "v2" ], "variable": [ { "key": "id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-1623793d-c507-48aa-9aa7-dc1427df9a1b" }, { "id": "6b1271e3-33a7-4dbf-bcac-4b56cc8ec857", "name": "POST Customer Identification Failed (Resource Not Found)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer Identification operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Link\",\n \"with_edd\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/identifications/v2", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications", "v2" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-6b1271e3-33a7-4dbf-bcac-4b56cc8ec857" }, { "id": "bf38ef6c-897b-4031-a170-95f34ea39c57", "name": "POST Customer Idenfication Failed (Has Pending Identification)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer Identification operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Link\",\n \"with_edd\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/identifications/v2", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications", "v2" ], "variable": [ { "key": "id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-bf38ef6c-897b-4031-a170-95f34ea39c57" }, { "id": "b669660f-8995-42ee-98a1-3d00dbdfa413", "name": "POST Customer Identification Failed (Creation Rate Limit Exceeded)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer Identification operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Link\",\n \"with_edd\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/identifications/v2", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications", "v2" ], "variable": [ { "key": "id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-b669660f-8995-42ee-98a1-3d00dbdfa413" }, { "id": "cfd0c435-c838-4eef-a32f-834c5cc51493", "name": "POST Customer Identification Failed (Internal Error)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer Identification operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the identification will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"Link\",\n \"with_edd\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/identifications/v2", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications", "v2" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-cfd0c435-c838-4eef-a32f-834c5cc51493" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-040bea49-b40b-4900-8eb5-9f591101f971" } ], "id": "4c5b8c03-e151-421e-a11d-ff6ca49c6c3c", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-4c5b8c03-e151-421e-a11d-ff6ca49c6c3c" }, { "name": "Get all customer Identifications", "id": "28c860f2-abfc-47fe-9bd3-155b874e97dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the identifications will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:id/identifications?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "id": "aae3b032-7952-4492-ac69-33246ee6ae13", "key": "id", "value": "", "description": "(Required) the ID of the Customer to get Identifications for" } ] }, "description": "Retrieve all identifications for this customer\n" }, "response": [ { "id": "739198fc-acb3-4d76-8625-b9726cd2e10a", "name": "GET ALL Identification Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the identifications will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/identifications?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"status\": \"Expired\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"partner_id\": \"\",\n \"residence_country\": \"\",\n \"review_comment\": \"\",\n \"step_status\": {\n \"company_beneficiaries\": {\n \"result\": \"Approved\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_data\": {\n \"result\": \"Processed\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_documents\": {\n \"result\": \"PendingReview\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"questionnaire\": {\n \"result\": \"PendingReview\",\n \"retry\": \"\",\n \"comment\": \"\"\n }\n },\n \"url\": \"\",\n \"with_edd\": \"\"\n },\n {\n \"id\": \"\",\n \"status\": \"Expired\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"partner_id\": \"\",\n \"residence_country\": \"\",\n \"review_comment\": \"\",\n \"step_status\": {\n \"company_beneficiaries\": {\n \"result\": \"Declined\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_data\": {\n \"result\": \"Pending\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_documents\": {\n \"result\": \"PendingReview\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"questionnaire\": {\n \"result\": \"Processed\",\n \"retry\": \"\",\n \"comment\": \"\"\n }\n },\n \"url\": \"\",\n \"with_edd\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"prev_cursor\": null\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-739198fc-acb3-4d76-8625-b9726cd2e10a" }, { "id": "adb3712a-9e0f-4b95-937b-5ddf11edfd98", "name": "GET ALL Identification Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the identifications will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/identifications?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-adb3712a-9e0f-4b95-937b-5ddf11edfd98" }, { "id": "fbc0ce5b-ddba-4b64-a5a2-419192ac8848", "name": "GET ALL Identification Failed (Resource Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the identifications will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/identifications?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-fbc0ce5b-ddba-4b64-a5a2-419192ac8848" }, { "id": "483a4955-5537-49bf-bad6-91421b05533c", "name": "GET ALL Identification Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the identifications will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/identifications?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "identifications" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-483a4955-5537-49bf-bad6-91421b05533c" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-28c860f2-abfc-47fe-9bd3-155b874e97dc" } ], "id": "3793eac6-7af0-49d1-8f50-4a8ac5f1019d", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-3793eac6-7af0-49d1-8f50-4a8ac5f1019d" }, { "name": "microdeposits", "item": [ { "name": "Get customer microdeposits", "id": "0ab26bc0-012d-4ce2-9652-82ef7ab47027", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:id/microdeposits", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "microdeposits" ], "variable": [ { "id": "5845c2a8-3c45-4edf-bb8f-5d163ceb09e2", "key": "id", "value": "", "description": "(Required) the ID of the Customer to GET microdeposits for" } ] }, "description": "Retrieve all microdeposits for a specific customer by ID\n" }, "response": [ { "id": "dcd79d0d-0678-49d0-8069-eb946481be51", "name": "GET Microdeposits Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/microdeposits", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "microdeposits" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"created_at\": \"\",\n \"counterparty_name\": \"\"\n },\n {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"created_at\": \"\",\n \"counterparty_name\": \"\"\n }\n]", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-dcd79d0d-0678-49d0-8069-eb946481be51" }, { "id": "cfe0040b-5935-4d81-b85b-e2e5aae1fcc8", "name": "GET Microdeposits Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/microdeposits", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "microdeposits" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-cfe0040b-5935-4d81-b85b-e2e5aae1fcc8" }, { "id": "cbda8a8c-0b71-431c-9b46-b459d1e71a19", "name": "GET Microdeposits Failed (Resource Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/microdeposits", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "microdeposits" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-cbda8a8c-0b71-431c-9b46-b459d1e71a19" }, { "id": "562a6370-f07e-450d-a386-922212ea6c73", "name": "GET Microdeposits Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/microdeposits", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "microdeposits" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-562a6370-f07e-450d-a386-922212ea6c73" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-0ab26bc0-012d-4ce2-9652-82ef7ab47027" } ], "id": "57c407de-f20b-4cba-a8c9-f0161c696855", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-57c407de-f20b-4cba-a8c9-f0161c696855" }, { "name": "required-signings", "item": [ { "name": "Get customer required signings", "id": "425e5e69-0bc1-431f-b163-6a3b45e730b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the required signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:id/required-signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "required-signings" ], "variable": [ { "id": "22232528-d0cc-4f11-904f-a290c2b0e265", "key": "id", "value": "", "description": "(Required) the ID of the Customer to get required signings for" } ] }, "description": "Get all required signings for a customer\n" }, "response": [ { "id": "8dfb9c85-b662-49a9-830c-a94cb7c07206", "name": "GET Required Signings Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the required signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/required-signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "required-signings" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"url\": \"\",\n \"display_name\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"display_name\": \"\"\n }\n]", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-8dfb9c85-b662-49a9-830c-a94cb7c07206" }, { "id": "18583881-6068-4eee-b4dd-67abc7a7b0c2", "name": "GET Required Signings Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the required signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/required-signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "required-signings" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-18583881-6068-4eee-b4dd-67abc7a7b0c2" }, { "id": "93e94495-6895-4852-aa4f-4512b3a79c49", "name": "GET Required Signings Failed (Forbidden)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the required signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/required-signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "required-signings" ], "variable": [ { "key": "id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-93e94495-6895-4852-aa4f-4512b3a79c49" }, { "id": "93f04beb-567d-45f3-9cee-43a92ba7fdd6", "name": "GET Required Signings Failed (Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the required signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/required-signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "required-signings" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-93f04beb-567d-45f3-9cee-43a92ba7fdd6" }, { "id": "24026977-a9b1-4221-b181-c5d238c0e60d", "name": "GET Required Signings Failed (Conflict)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the required signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/required-signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "required-signings" ], "variable": [ { "key": "id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-24026977-a9b1-4221-b181-c5d238c0e60d" }, { "id": "75e597c4-96ab-4e82-a89d-ce38c4c01ae1", "name": "GET Required Signings Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the required signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/required-signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "required-signings" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-75e597c4-96ab-4e82-a89d-ce38c4c01ae1" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-425e5e69-0bc1-431f-b163-6a3b45e730b2" } ], "id": "6a62e3d2-841d-4de7-8842-c0ed3fd6daaa", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-6a62e3d2-841d-4de7-8842-c0ed3fd6daaa" }, { "name": "requirements", "item": [ { "name": "Get customer requirements", "id": "2846c491-4c87-473b-b701-b426079b2e85", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:id/requirements", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "requirements" ], "variable": [ { "id": "d67157c3-904d-4c18-a1c6-1a4450ac5a84", "key": "id", "value": "", "description": "(Required) the ID of the Customer to GET requirements for" } ] }, "description": "Retrieve a requirements view of a customer:\nfour buckets \u2014 `complete`, `pending`, `missing`, `issues` \u2014 plus a\ncoarse `requirements_due` summary of categories that still need\nattention. Each requirement carries a stable typed `code` (switch on\nthis) and, when available, a verbatim `description` from the upstream\nKYC provider's moderation comment. **NOTE**: The `description` field is subject to change without notice.\n\nComputed on demand from the customer's identifications and\ncustomer-level state; no separate ingestion step is needed." }, "response": [ { "id": "61b64328-ae3c-458f-80bd-6fa3ed9efa58", "name": "GET Customer Requirements Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/requirements", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "requirements" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"requirements_due\": [\n \"kyb\",\n \"kyc\"\n ],\n \"complete\": [\n {\n \"code\": \"kyb_company_documents\",\n \"reject_labels\": [\n \"\",\n \"\"\n ],\n \"reject_reasons\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"missing_questions\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n }\n ],\n \"description\": \"\",\n \"identification_id\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"kyb_company_data\",\n \"reject_labels\": [\n \"\",\n \"\"\n ],\n \"reject_reasons\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"missing_questions\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n }\n ],\n \"description\": \"\",\n \"identification_id\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"pending\": [\n {\n \"code\": \"kyc_identity\",\n \"reject_labels\": [\n \"\",\n \"\"\n ],\n \"reject_reasons\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"missing_questions\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n }\n ],\n \"description\": \"\",\n \"identification_id\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"kyc_proof_of_residence\",\n \"reject_labels\": [\n \"\",\n \"\"\n ],\n \"reject_reasons\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"missing_questions\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n }\n ],\n \"description\": \"\",\n \"identification_id\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"missing\": [\n {\n \"code\": \"kyc_selfie\",\n \"reject_labels\": [\n \"\",\n \"\"\n ],\n \"reject_reasons\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"missing_questions\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n }\n ],\n \"description\": \"\",\n \"identification_id\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"kyb_data_missing\",\n \"reject_labels\": [\n \"\",\n \"\"\n ],\n \"reject_reasons\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"missing_questions\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n }\n ],\n \"description\": \"\",\n \"identification_id\": \"\",\n \"retryable\": \"\"\n }\n ],\n \"issues\": [\n {\n \"code\": \"kyb_data_invalid\",\n \"reject_labels\": [\n \"\",\n \"\"\n ],\n \"reject_reasons\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"missing_questions\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n }\n ],\n \"description\": \"\",\n \"identification_id\": \"\",\n \"retryable\": \"\"\n },\n {\n \"code\": \"kyc_proof_of_residence\",\n \"reject_labels\": [\n \"\",\n \"\"\n ],\n \"reject_reasons\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"missing_questions\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"section_id\": \"\"\n }\n ],\n \"description\": \"\",\n \"identification_id\": \"\",\n \"retryable\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-61b64328-ae3c-458f-80bd-6fa3ed9efa58" }, { "id": "972973b7-a677-4145-86c1-4cd28ec64b3d", "name": "GET Customer Requirements Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/requirements", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "requirements" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-972973b7-a677-4145-86c1-4cd28ec64b3d" }, { "id": "93af35d3-4d47-4240-8b81-8c3feaeacb3d", "name": "GET Customer Requirements Failed (Resource Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/requirements", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "requirements" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-93af35d3-4d47-4240-8b81-8c3feaeacb3d" }, { "id": "72e5f5b2-16f9-48f7-8bc6-6df6aeae3489", "name": "GET Customer Requirements Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/requirements", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "requirements" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-72e5f5b2-16f9-48f7-8bc6-6df6aeae3489" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-2846c491-4c87-473b-b701-b426079b2e85" } ], "id": "173bd322-5e94-4b4a-b70f-c9930a1de39d", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-173bd322-5e94-4b4a-b70f-c9930a1de39d" }, { "name": "signings", "item": [ { "name": "Get all customer Signings", "id": "f949d9c3-b597-42c7-90af-cd392ab110ad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:id/signings?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "id": "7faa90af-fe22-4785-a93b-e8524a9f0308", "key": "id", "value": "", "description": "(Required) the ID of the Customer to get Signings for" } ] }, "description": "Retrieve all signings for a customer, representing the various legal agreements and consents gathered from the customer.\nSee The KYC/Compliance section of our documentation for more info.\n" }, "response": [ { "id": "2a863aac-37c9-40ff-a117-7c2f8453859b", "name": "GET Signings Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/signings?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"customer_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"content_id\": \"\",\n \"document_id\": \"\"\n },\n {\n \"id\": \"\",\n \"customer_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"content_id\": \"\",\n \"document_id\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"prev_cursor\": null\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-2a863aac-37c9-40ff-a117-7c2f8453859b" }, { "id": "99a87555-0596-48eb-b5a3-1b65710b118c", "name": "GET Signings Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/signings?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-99a87555-0596-48eb-b5a3-1b65710b118c" }, { "id": "d9707490-7022-4029-9145-b2f15a3912c2", "name": "GET Signings Resource Not found", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/signings?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-d9707490-7022-4029-9145-b2f15a3912c2" }, { "id": "85767963-6767-4bf9-ab44-a2ff356ea64d", "name": "GET Signings Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the signings will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/signings?cursor=&page_size=10", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" } ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-85767963-6767-4bf9-ab44-a2ff356ea64d" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f949d9c3-b597-42c7-90af-cd392ab110ad" }, { "name": "Create a new Customer signing", "id": "a2bfc10c-232b-48eb-a1d0-dec8586336fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Signing operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the signing will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"signed\": \"\",\n \"content_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "variable": [ { "id": "ca6c4866-0817-4e32-a28a-30fb83acdde3", "key": "id", "value": "", "description": "(Required) the ID of the Customer to create a Signing for" } ] }, "description": "This will create a signing for the customer, representing the legal consent to a specific Document.\nSee The KYC/Compliance section of our documentation for more info.\n\n" }, "response": [ { "id": "124f65dc-311a-4fe3-ac84-6ef7de9e376a", "name": "POST Signing Succeeded", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Signing operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the signing will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"signed\": \"\",\n \"content_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "variable": [ { "key": "id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"customer_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"content_id\": \"\",\n \"document_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-124f65dc-311a-4fe3-ac84-6ef7de9e376a" }, { "id": "117d4e1a-6272-4139-a55e-eb891e0c49eb", "name": "POST Signing Failed (Unauthorized)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Signing operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the signing will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"signed\": \"\",\n \"content_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-117d4e1a-6272-4139-a55e-eb891e0c49eb" }, { "id": "c330f5e7-05d4-4fcd-b9b7-43960ea329ed", "name": "POST Signing Failed (Forbidden)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Signing operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the signing will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"signed\": \"\",\n \"content_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "variable": [ { "key": "id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-c330f5e7-05d4-4fcd-b9b7-43960ea329ed" }, { "id": "4e97ed48-5b76-45e8-9e59-dc5ac1df1bd0", "name": "POST Signing Failed (Not Found)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Signing operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the signing will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"signed\": \"\",\n \"content_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-4e97ed48-5b76-45e8-9e59-dc5ac1df1bd0" }, { "id": "b71c2b99-9cb6-43ac-a370-b12e18fb4791", "name": "POST Signing Failed (Validation Error)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Signing operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the signing will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"signed\": \"\",\n \"content_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-b71c2b99-9cb6-43ac-a370-b12e18fb4791" }, { "id": "f311f4c6-4a71-4247-b945-b4124e24f143", "name": "POST Signing Failed (Internal Error)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Signing operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the signing will be created under scope of the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"signed\": \"\",\n \"content_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id/signings", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "signings" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f311f4c6-4a71-4247-b945-b4124e24f143" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-a2bfc10c-232b-48eb-a1d0-dec8586336fc" } ], "id": "c1e16ce7-0af0-4ae2-8fcd-db55ff923f9b", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-c1e16ce7-0af0-4ae2-8fcd-db55ff923f9b" }, { "name": "spending-limit", "item": [ { "name": "Get customer spending limit usage", "id": "5cc6da8a-bd72-48b8-8cd9-c762761a6a7b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:id/spending-limit", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "spending-limit" ], "variable": [ { "id": "c87c0685-f171-42c4-8873-ddb1b88a1f16", "key": "id", "value": "", "description": "(Required) the ID of the Customer to GET the spending limit for" } ] }, "description": "Retrieve the current spending limit usage for a specific customer,\nsplit by direction (fiat on-ramp and crypto off-ramp).\n\nAmounts are returned in **EUR cents** as strings.\n\n`threshold_eur` (and therefore `remaining_eur`) is `null` for Business\ncustomers and persons with `ThresholdKind::Regulated`. `null` means\n\"no enforced cap\"" }, "response": [ { "id": "bdcf493a-3931-4425-afbb-396d03e6dcf2", "name": "GET Customer Spending Limit Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/spending-limit", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "spending-limit" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"fiat_onramp\": {\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"used_eur\": \"\",\n \"remaining_eur\": \"\",\n \"threshold_eur\": \"\"\n },\n \"crypto_offramp\": {\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"used_eur\": \"\",\n \"remaining_eur\": \"\",\n \"threshold_eur\": \"\"\n }\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-bdcf493a-3931-4425-afbb-396d03e6dcf2" }, { "id": "68e7380a-4b2d-4716-8e02-d4a771390ca8", "name": "GET Customer Spending Limit Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/spending-limit", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "spending-limit" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-68e7380a-4b2d-4716-8e02-d4a771390ca8" }, { "id": "f69e5f37-b13a-4dee-9952-ad9cc1c9a4fa", "name": "GET Customer Spending Limit Failed (Resource Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/spending-limit", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "spending-limit" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f69e5f37-b13a-4dee-9952-ad9cc1c9a4fa" }, { "id": "0b309386-831c-499f-97b6-7590cd56fbcd", "name": "GET Customer Spending Limit Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id/spending-limit", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "spending-limit" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-0b309386-831c-499f-97b6-7590cd56fbcd" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-5cc6da8a-bd72-48b8-8cd9-c762761a6a7b" } ], "id": "15833abe-0737-40a5-a5cc-300e831b3d41", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-15833abe-0737-40a5-a5cc-300e831b3d41" }, { "name": "Get a customer by ID", "id": "f4c31c7d-39bc-461c-a1d0-d4380ab2d7db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "id": "8d596761-44f3-43d5-8715-9354705d6079", "key": "id", "value": "", "description": "(Required) the ID of the Customer to GET" } ] }, "description": "Retrieve a specific customer by ID\n" }, "response": [ { "id": "9a50d809-667a-4e80-9743-27de0467b0ac", "name": "GET Customer Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"customer_type\": \"Person\",\n \"identification_ids\": [\n \"\",\n \"\"\n ],\n \"signing_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"Active\",\n \"name\": \"\",\n \"email\": \"\",\n \"partner_id\": \"\",\n \"active_email\": \"\",\n \"external_id\": \"\",\n \"identification_status\": \"Approved\",\n \"spending_limit_euro\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-9a50d809-667a-4e80-9743-27de0467b0ac" }, { "id": "a97f4b20-d118-4710-aa4d-c8c52a8d8fb6", "name": "GET Customer Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-a97f4b20-d118-4710-aa4d-c8c52a8d8fb6" }, { "id": "e52860ce-4031-41c5-8b97-509b1ae7ec36", "name": "GET Customer Failed (Resource Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-e52860ce-4031-41c5-8b97-509b1ae7ec36" }, { "id": "f54b1799-b5ae-4db2-ba74-bec87324c0c1", "name": "GET Customer Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f54b1799-b5ae-4db2-ba74-bec87324c0c1" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f4c31c7d-39bc-461c-a1d0-d4380ab2d7db" }, { "name": "Update a customer", "id": "e8af17b2-103b-4dcd-819c-ddb7e93aa704", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "id": "94fa105b-3962-41ab-9404-0d7bd9ce93f7", "key": "id", "value": "", "description": "(Required) the ID of the Customer to update" } ] }, "description": "Update a customer by ID\n" }, "response": [ { "id": "0d94f0ef-e963-429b-9edd-9c33268a4482", "name": "PUT Customer Succeeded", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"customer_type\": \"Person\",\n \"identification_ids\": [\n \"\",\n \"\"\n ],\n \"signing_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"Active\",\n \"name\": \"\",\n \"email\": \"\",\n \"partner_id\": \"\",\n \"active_email\": \"\",\n \"external_id\": \"\",\n \"identification_status\": \"Approved\",\n \"spending_limit_euro\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-0d94f0ef-e963-429b-9edd-9c33268a4482" }, { "id": "350e4608-b3b1-4640-ac40-1ffe0327bf3d", "name": "PUT Customer Failed (Bad Request)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-350e4608-b3b1-4640-ac40-1ffe0327bf3d" }, { "id": "5c682f58-0d66-4064-a8b9-ed45d99add3a", "name": "PUT Customer Failed (Unauthorized)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-5c682f58-0d66-4064-a8b9-ed45d99add3a" }, { "id": "d4639a1e-edfe-4c01-86ed-b2e18705ee6e", "name": "PUT Customer Failed (Internal Error)", "originalRequest": { "method": "PUT", "header": [ { "description": "Optional sub-partner UUID, if provided, the wallet address will be registered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"external_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-d4639a1e-edfe-4c01-86ed-b2e18705ee6e" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-e8af17b2-103b-4dcd-819c-ddb7e93aa704" } ], "id": "19ecc687-b9df-4124-a649-0f46410da62e", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-19ecc687-b9df-4124-a649-0f46410da62e" }, { "name": "Get all Customers", "id": "fed5bf77-5977-4bfc-93ed-18810a119568", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customers will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/customers?cursor=&prev_cursor=&page_size=10&search_term=&status=&identification_status=&customer_type=&has_transactions=&sort_order=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the customers", "key": "search_term", "value": "" }, { "description": "Filter by customer status (comma-separated or repeated values)", "key": "status", "value": "" }, { "description": "Filter by the customer's most-recent identification status", "key": "identification_status", "value": "" }, { "description": "Filter by customer type (Person or Business)", "key": "customer_type", "value": "" }, { "description": "When true, only customers with at least one transaction; when\nfalse, only customers without any. Omit to disable the filter.", "key": "has_transactions", "value": "" }, { "description": "Sort order: \"asc\" for oldest first, \"desc\" for newest first (default)", "key": "sort_order", "value": "" } ] }, "description": "Get all customers for a particular partner. The partner ID does not need to be provided as it\nis provided by the API Key.\n\nAn optional `search_term` can be provided to filter by name, id, email, or external id.\n" }, "response": [ { "id": "b03bd8ab-b3db-401c-9dec-5c57e5b25751", "name": "GET ALL Customer Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customers will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers?cursor=&prev_cursor=&page_size=10&search_term=&status=&identification_status=&customer_type=&has_transactions=&sort_order=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the customers", "key": "search_term", "value": "" }, { "description": "Filter by customer status (comma-separated or repeated values)", "key": "status", "value": "" }, { "description": "Filter by the customer's most-recent identification status", "key": "identification_status", "value": "" }, { "description": "Filter by customer type (Person or Business)", "key": "customer_type", "value": "" }, { "description": "When true, only customers with at least one transaction; when\nfalse, only customers without any. Omit to disable the filter.", "key": "has_transactions", "value": "" }, { "description": "Sort order: \"asc\" for oldest first, \"desc\" for newest first (default)", "key": "sort_order", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"customer_type\": \"Business\",\n \"identification_ids\": [\n \"\",\n \"\"\n ],\n \"signing_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"Archived\",\n \"name\": \"\",\n \"email\": \"\",\n \"partner_id\": \"\",\n \"active_email\": \"\",\n \"external_id\": \"\",\n \"identification_status\": \"Approved\",\n \"spending_limit_euro\": \"\"\n },\n {\n \"id\": \"\",\n \"customer_type\": \"Business\",\n \"identification_ids\": [\n \"\",\n \"\"\n ],\n \"signing_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"SigningsRequired\",\n \"name\": \"\",\n \"email\": \"\",\n \"partner_id\": \"\",\n \"active_email\": \"\",\n \"external_id\": \"\",\n \"identification_status\": \"PendingReview\",\n \"spending_limit_euro\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"prev_cursor\": null\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-b03bd8ab-b3db-401c-9dec-5c57e5b25751" }, { "id": "9b84acd4-9916-4d43-bf75-416f57ef77f7", "name": "GET ALL Customer Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customers will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers?cursor=&prev_cursor=&page_size=10&search_term=&status=&identification_status=&customer_type=&has_transactions=&sort_order=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the customers", "key": "search_term", "value": "" }, { "description": "Filter by customer status (comma-separated or repeated values)", "key": "status", "value": "" }, { "description": "Filter by the customer's most-recent identification status", "key": "identification_status", "value": "" }, { "description": "Filter by customer type (Person or Business)", "key": "customer_type", "value": "" }, { "description": "When true, only customers with at least one transaction; when\nfalse, only customers without any. Omit to disable the filter.", "key": "has_transactions", "value": "" }, { "description": "Sort order: \"asc\" for oldest first, \"desc\" for newest first (default)", "key": "sort_order", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-9b84acd4-9916-4d43-bf75-416f57ef77f7" }, { "id": "ba9fb750-cbcf-4a17-b7b6-f0fe7b5cd72a", "name": "GET ALL Customer Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Optional sub-partner UUID, if provided, the customers will be filtered for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/customers?cursor=&prev_cursor=&page_size=10&search_term=&status=&identification_status=&customer_type=&has_transactions=&sort_order=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "Paging: the cursor field from previous page", "key": "cursor", "value": "" }, { "description": "Paging: the cursor field for backward pagination", "key": "prev_cursor", "value": "" }, { "description": "Paging: the requested page size (max 100)", "key": "page_size", "value": "10" }, { "description": "A search term to filter the customers", "key": "search_term", "value": "" }, { "description": "Filter by customer status (comma-separated or repeated values)", "key": "status", "value": "" }, { "description": "Filter by the customer's most-recent identification status", "key": "identification_status", "value": "" }, { "description": "Filter by customer type (Person or Business)", "key": "customer_type", "value": "" }, { "description": "When true, only customers with at least one transaction; when\nfalse, only customers without any. Omit to disable the filter.", "key": "has_transactions", "value": "" }, { "description": "Sort order: \"asc\" for oldest first, \"desc\" for newest first (default)", "key": "sort_order", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-ba9fb750-cbcf-4a17-b7b6-f0fe7b5cd72a" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-fed5bf77-5977-4bfc-93ed-18810a119568" }, { "name": "Create a new customer", "id": "89120fdb-7628-4694-b3b3-d0eac857fe20", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the customer will be created for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "body": { "mode": "raw", "raw": "{\n \"customer_type\": \"Business\",\n \"email\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] }, "description": "Create a new **business** or **legal person** customer.\n" }, "response": [ { "id": "1a27df30-190b-444a-b23c-d7ef8f9331bf", "name": "POST Customer Succeeded", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the customer will be created for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_type\": \"Business\",\n \"email\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"customer_type\": \"Person\",\n \"identification_ids\": [\n \"\",\n \"\"\n ],\n \"signing_ids\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"status\": \"Active\",\n \"name\": \"\",\n \"email\": \"\",\n \"partner_id\": \"\",\n \"active_email\": \"\",\n \"external_id\": \"\",\n \"identification_status\": \"Approved\",\n \"spending_limit_euro\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-1a27df30-190b-444a-b23c-d7ef8f9331bf" }, { "id": "67d6ce4c-13e7-4269-9352-a90f10abd62f", "name": "POST Customer Failed (Bad Request)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the customer will be created for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_type\": \"Business\",\n \"email\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-67d6ce4c-13e7-4269-9352-a90f10abd62f" }, { "id": "f0e963df-5a31-409c-8a4f-3c5426841a92", "name": "POST Customer Failed (Unauthorized)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the customer will be created for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_type\": \"Business\",\n \"email\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f0e963df-5a31-409c-8a4f-3c5426841a92" }, { "id": "e3cea0e9-73f0-4c13-a470-3eaf43d6221a", "name": "POST Customer Failed (Internal Error)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) a UUID ensuring an Customer operation is only processed once", "key": "IDEMPOTENCY-KEY", "value": "" }, { "description": "Optional sub-partner UUID, if provided, the customer will be created for the sub-partner", "key": "X-SUB-PARTNER-ID", "value": "" }, { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Content-Type", "value": "application/json; charset=utf-8" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_type\": \"Business\",\n \"email\": \"\",\n \"external_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-e3cea0e9-73f0-4c13-a470-3eaf43d6221a" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-89120fdb-7628-4694-b3b3-d0eac857fe20" } ], "id": "1c6143ab-f089-426c-bfe1-abcd80d73e86", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-1c6143ab-f089-426c-bfe1-abcd80d73e86" }, { "name": "identifications", "item": [ { "name": "{id}", "item": [ { "name": "archive", "item": [ { "name": "Archive an identification", "id": "00afaf3a-983f-44fd-89ad-ecd7b00eb6ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "archive" ], "variable": [ { "id": "392d8576-dbab-421a-abe2-7b55922665ed", "key": "id", "value": "", "description": "(Required) the ID of the Identification to archive" } ] }, "description": "Archive an identification. This is terminal and cannot be undone: the\nidentification is permanently invalidated and can no longer be used to\nverify the customer.\n" }, "response": [ { "id": "a06a9dc6-ab03-48bf-a513-9199514fe489", "name": "Identification Archived", "originalRequest": { "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "archive" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"Declined\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"partner_id\": \"\",\n \"residence_country\": \"\",\n \"review_comment\": \"\",\n \"step_status\": {\n \"company_beneficiaries\": {\n \"result\": \"Declined\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_data\": {\n \"result\": \"Processed\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_documents\": {\n \"result\": \"Archived\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"questionnaire\": {\n \"result\": \"PendingReview\",\n \"retry\": \"\",\n \"comment\": \"\"\n }\n },\n \"url\": \"\",\n \"with_edd\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-a06a9dc6-ab03-48bf-a513-9199514fe489" }, { "id": "4a8b24d0-5a3a-4b93-878a-8135da217fb9", "name": "Archive Identification Failed (Unauthorized)", "originalRequest": { "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "archive" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-4a8b24d0-5a3a-4b93-878a-8135da217fb9" }, { "id": "6c96d8c4-af9d-4d24-bf13-f85b1b4a5850", "name": "Archive Identification Failed (ResourceNotFound)", "originalRequest": { "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "archive" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-6c96d8c4-af9d-4d24-bf13-f85b1b4a5850" }, { "id": "341b4ffc-c9ee-4100-adfb-73e4c34cd9eb", "name": "Archive Identification Failed (Internal Error)", "originalRequest": { "method": "PUT", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "archive" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-341b4ffc-c9ee-4100-adfb-73e4c34cd9eb" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-00afaf3a-983f-44fd-89ad-ecd7b00eb6ab" } ], "id": "79410f17-af0c-4492-ab48-1dd745158adc", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-79410f17-af0c-4492-ab48-1dd745158adc" }, { "name": "compliance-questionnaire", "item": [ { "name": "Fetch identification compliance questionnaire", "id": "932669e2-d055-43f8-8ff1-e5fc8d6ba44f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/compliance-questionnaire", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "compliance-questionnaire" ], "variable": [ { "id": "48ed11cf-b0dc-49d8-a021-f30b7ad6af31", "key": "id", "value": "", "description": "(Required) the ID of the Identification to get compliance questions for" } ] }, "description": "Fetch the compliance questionnaire for an identification\n" }, "response": [ { "id": "459bf60b-bf76-4ba8-96c8-647a15fc019e", "name": "GET Compliance Question Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/compliance-questionnaire", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "compliance-questionnaire" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"intended_use\": \"Trading\",\n \"employment_status\": \"Student\",\n \"expected_monthly_volume\": \"LessThan1000\",\n \"monthly_income\": \"Between5000And10000\",\n \"occupation\": \"BusinessOwner\",\n \"source_of_funds\": \"SalaryAndWages\",\n \"source_of_funds_proof\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-459bf60b-bf76-4ba8-96c8-647a15fc019e" }, { "id": "7ebe5d2a-5137-40b2-9483-d4ae8e4738ac", "name": "GET Compliance Question Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/compliance-questionnaire", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "compliance-questionnaire" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-7ebe5d2a-5137-40b2-9483-d4ae8e4738ac" }, { "id": "5a29efd2-dae2-4078-98be-ee90a7c5f58a", "name": "GET Compliance Question Failed (Resource Not Found)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/compliance-questionnaire", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "compliance-questionnaire" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-5a29efd2-dae2-4078-98be-ee90a7c5f58a" }, { "id": "6fcbc671-c747-42de-b55c-fb79b0f70c05", "name": "GET Compliance Question Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id/compliance-questionnaire", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id", "compliance-questionnaire" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-6fcbc671-c747-42de-b55c-fb79b0f70c05" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-932669e2-d055-43f8-8ff1-e5fc8d6ba44f" } ], "id": "260ff1f2-f0de-484c-8018-7b80c7e2e1d0", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-260ff1f2-f0de-484c-8018-7b80c7e2e1d0" }, { "name": "Get an Identification by ID", "id": "5b15ef28-d527-4a9a-bd66-37eb6d916a74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" } ], "url": { "raw": "{{baseUrl}}/identifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id" ], "variable": [ { "id": "92bd044a-9936-411e-9f9f-1be3283b8a43", "key": "id", "value": "", "description": "(Required) the ID of the Identification to GET" } ] }, "description": "Retrieve a specific Identification by ID\n" }, "response": [ { "id": "f5bcc2a1-e7b6-4252-9ad5-bcfee8bc7535", "name": "GET Identification Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": \"Declined\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_id\": \"\",\n \"partner_id\": \"\",\n \"residence_country\": \"\",\n \"review_comment\": \"\",\n \"step_status\": {\n \"company_beneficiaries\": {\n \"result\": \"Declined\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_data\": {\n \"result\": \"Processed\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"company_documents\": {\n \"result\": \"Archived\",\n \"retry\": \"\",\n \"comment\": \"\"\n },\n \"questionnaire\": {\n \"result\": \"PendingReview\",\n \"retry\": \"\",\n \"comment\": \"\"\n }\n },\n \"url\": \"\",\n \"with_edd\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f5bcc2a1-e7b6-4252-9ad5-bcfee8bc7535" }, { "id": "f79dbc4b-18e8-4e6e-8385-91672fe67b23", "name": "GET Identification Failed (Unauthorized)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-f79dbc4b-18e8-4e6e-8385-91672fe67b23" }, { "id": "1c15070d-38ec-44ef-a329-7a7265f95040", "name": "GET Identification Failed (Forbidden)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-1c15070d-38ec-44ef-a329-7a7265f95040" }, { "id": "27ff5fcd-606b-41c2-842c-e70b27f3b816", "name": "GET Identification Failed (ResourceNotFound)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-27ff5fcd-606b-41c2-842c-e70b27f3b816" }, { "id": "e87d7d15-985e-4533-a085-04d5dcbdaa85", "name": "GET Identification Failed (Internal Error)", "originalRequest": { "method": "GET", "header": [ { "description": "Selects the API version for this request, as an ISO date (`YYYY-MM-DD`). Omit to use the default version (`2025-03-13`). Supported versions: 2025-03-13, 2026-07-01.", "key": "X-API-Version", "value": "" }, { "key": "Accept", "value": "application/json; charset=utf-8" }, { "description": "Added as a part of security scheme: apikey", "key": "X-API-Key", "value": "" } ], "url": { "raw": "{{baseUrl}}/identifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "identifications", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json; charset=utf-8" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"trace_id\": \"\"\n}", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-e87d7d15-985e-4533-a085-04d5dcbdaa85" } ], "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-5b15ef28-d527-4a9a-bd66-37eb6d916a74" } ], "id": "7c7acdbb-45cb-4d1d-8af3-7d1306bcef48", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-7c7acdbb-45cb-4d1d-8af3-7d1306bcef48" } ], "id": "abf6564d-a925-4612-b921-4779d1416234", "createdAt": "2026-07-28T03:23:48.000Z", "updatedAt": "2026-07-28T03:23:48.000Z", "uid": "35240-abf6564d-a925-4612-b921-4779d1416234" } ], "variable": [ { "key": "baseUrl", "value": "https://api.sandbox.iron.xyz/api" } ] }