{ "info": { "_postman_id": "de955cba-c11c-4cd4-a57b-be910a60fa01", "name": "api-onboarding Account Usage API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:27:35.000Z", "updatedAt": "2026-07-28T01:27:35.000Z", "lastUpdatedBy": "35240", "uid": "35240-de955cba-c11c-4cd4-a57b-be910a60fa01" }, "item": [ { "name": "v1", "item": [ { "name": "forms", "item": [ { "name": "{form_id}", "item": [ { "name": "account_usage", "item": [ { "name": "Get Account Usage", "id": "ee5c5fa8-9362-4e52-88db-9ebf0185033f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "id": "25fa44d5-f45b-4411-8432-8dad88a34a14", "key": "form_id", "value": "", "description": "(Required) Form UUID" } ] }, "description": "Gets the associated account usage for a form. The account usage outlines how the applicant intends to use their account." }, "response": [ { "id": "73561838-c196-4d1f-a228-55efb15b9517", "name": "Account usage found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "key": "form_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"collections_account\": \"\",\n \"one_off_transaction\": \"\",\n \"id\": \"\",\n \"form_id\": \"\",\n \"document_ids\": [\n \"\",\n \"\"\n ],\n \"collection_currencies\": [\n \"\",\n \"\"\n ],\n \"payment_currencies\": [\n \"\",\n \"\"\n ],\n \"transaction_countries\": [\n \"\",\n \"\"\n ],\n \"estimated_monthly_transaction_currency\": \"\",\n \"estimated_monthly_transaction_value\": \"\",\n \"estimated_monthly_transaction_volume\": \"\",\n \"source_of_funds\": \"\",\n \"primary_purpose\": \"\",\n \"purpose_details\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-73561838-c196-4d1f-a228-55efb15b9517" }, { "id": "3e0f5119-3dc6-4299-bc09-8613e75c700b", "name": "Returns error if form not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "key": "form_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error_code\": \"\",\n \"reason\": \"\",\n \"error_messages\": {}\n}", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-3e0f5119-3dc6-4299-bc09-8613e75c700b" } ], "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-ee5c5fa8-9362-4e52-88db-9ebf0185033f" }, { "name": "Update Account Usage", "id": "5a1015c9-b8fd-40e4-ad40-99215c6e0778", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"collections_account\": \"\",\n \"primary_purpose\": \"other\",\n \"document_ids\": [\n \"\",\n \"\"\n ],\n \"collection_currencies\": [\n \"SGD\",\n \"OMR\"\n ],\n \"payment_currencies\": [\n \"PKR\",\n \"BBD\"\n ],\n \"transaction_countries\": [\n \"NI\",\n \"BA\"\n ],\n \"one_off_transaction\": \"\",\n \"estimated_monthly_transaction_currency\": \"\",\n \"estimated_monthly_transaction_value\": \"\",\n \"estimated_monthly_transaction_volume\": \"\",\n \"source_of_funds\": \"loan\",\n \"purpose_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "id": "3756f395-dd6f-464e-9e4d-2e2f047d433c", "key": "form_id", "value": "", "description": "(Required) Form UUID" } ] }, "description": "Updates a form's associated account usage. The account usage outlines how the applicant intends to use their account." }, "response": [ { "id": "e0ddcf31-8f60-47dd-892c-18a6c4b56fc9", "name": "Updates account usage.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"collections_account\": \"\",\n \"primary_purpose\": \"other\",\n \"document_ids\": [\n \"\",\n \"\"\n ],\n \"collection_currencies\": [\n \"SGD\",\n \"OMR\"\n ],\n \"payment_currencies\": [\n \"PKR\",\n \"BBD\"\n ],\n \"transaction_countries\": [\n \"NI\",\n \"BA\"\n ],\n \"one_off_transaction\": \"\",\n \"estimated_monthly_transaction_currency\": \"\",\n \"estimated_monthly_transaction_value\": \"\",\n \"estimated_monthly_transaction_volume\": \"\",\n \"source_of_funds\": \"loan\",\n \"purpose_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "key": "form_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"collections_account\": \"\",\n \"one_off_transaction\": \"\",\n \"id\": \"\",\n \"form_id\": \"\",\n \"document_ids\": [\n \"\",\n \"\"\n ],\n \"collection_currencies\": [\n \"\",\n \"\"\n ],\n \"payment_currencies\": [\n \"\",\n \"\"\n ],\n \"transaction_countries\": [\n \"\",\n \"\"\n ],\n \"estimated_monthly_transaction_currency\": \"\",\n \"estimated_monthly_transaction_value\": \"\",\n \"estimated_monthly_transaction_volume\": \"\",\n \"source_of_funds\": \"\",\n \"primary_purpose\": \"\",\n \"purpose_details\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-e0ddcf31-8f60-47dd-892c-18a6c4b56fc9" }, { "id": "2ae929dd-5f4c-47b2-b8fd-bbd0ab8e6c9a", "name": "Returns error if any request body schema validation fails", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"collections_account\": \"\",\n \"primary_purpose\": \"other\",\n \"document_ids\": [\n \"\",\n \"\"\n ],\n \"collection_currencies\": [\n \"SGD\",\n \"OMR\"\n ],\n \"payment_currencies\": [\n \"PKR\",\n \"BBD\"\n ],\n \"transaction_countries\": [\n \"NI\",\n \"BA\"\n ],\n \"one_off_transaction\": \"\",\n \"estimated_monthly_transaction_currency\": \"\",\n \"estimated_monthly_transaction_value\": \"\",\n \"estimated_monthly_transaction_volume\": \"\",\n \"source_of_funds\": \"loan\",\n \"purpose_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "key": "form_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error_code\": \"\",\n \"reason\": \"\",\n \"error_messages\": {}\n}", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-2ae929dd-5f4c-47b2-b8fd-bbd0ab8e6c9a" }, { "id": "ec6d2a6b-06ca-474d-8de9-3c50a8bbde89", "name": "Form not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"collections_account\": \"\",\n \"primary_purpose\": \"other\",\n \"document_ids\": [\n \"\",\n \"\"\n ],\n \"collection_currencies\": [\n \"SGD\",\n \"OMR\"\n ],\n \"payment_currencies\": [\n \"PKR\",\n \"BBD\"\n ],\n \"transaction_countries\": [\n \"NI\",\n \"BA\"\n ],\n \"one_off_transaction\": \"\",\n \"estimated_monthly_transaction_currency\": \"\",\n \"estimated_monthly_transaction_value\": \"\",\n \"estimated_monthly_transaction_volume\": \"\",\n \"source_of_funds\": \"loan\",\n \"purpose_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "key": "form_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error_code\": \"\",\n \"reason\": \"\",\n \"error_messages\": {}\n}", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-ec6d2a6b-06ca-474d-8de9-3c50a8bbde89" }, { "id": "afe20054-0bb4-4a1f-9266-bfbb071ce648", "name": "Form is already submitted", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"collections_account\": \"\",\n \"primary_purpose\": \"other\",\n \"document_ids\": [\n \"\",\n \"\"\n ],\n \"collection_currencies\": [\n \"SGD\",\n \"OMR\"\n ],\n \"payment_currencies\": [\n \"PKR\",\n \"BBD\"\n ],\n \"transaction_countries\": [\n \"NI\",\n \"BA\"\n ],\n \"one_off_transaction\": \"\",\n \"estimated_monthly_transaction_currency\": \"\",\n \"estimated_monthly_transaction_value\": \"\",\n \"estimated_monthly_transaction_volume\": \"\",\n \"source_of_funds\": \"loan\",\n \"purpose_details\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "key": "form_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error_code\": \"\",\n \"reason\": \"\",\n \"error_messages\": {}\n}", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-afe20054-0bb4-4a1f-9266-bfbb071ce648" } ], "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-5a1015c9-b8fd-40e4-ad40-99215c6e0778" }, { "name": "Delete Account Usage", "id": "dfd8b2ad-8a22-481c-95cd-41d917892fff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "id": "e29c5b15-1bc4-40f9-bd05-b5389dbe7981", "key": "form_id", "value": "", "description": "(Required) Form UUID" } ] }, "description": "Deletes the account usage for the specified application form." }, "response": [ { "id": "45983958-f27e-4d27-972c-086d3d5ef61a", "name": "Deletes account usage if it exists", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "key": "form_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"message\": \"\",\n \"form_id\": \"\"\n }\n}", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-45983958-f27e-4d27-972c-086d3d5ef61a" }, { "id": "403fadc5-5ad1-4c55-96bc-0485b03b8d2f", "name": "Form not found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "key": "form_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error_code\": \"\",\n \"reason\": \"\",\n \"error_messages\": {}\n}", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-403fadc5-5ad1-4c55-96bc-0485b03b8d2f" }, { "id": "def85c87-44a6-4fdf-b677-23b77892dcc3", "name": "Form is already submitted", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/forms/:form_id/account_usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "forms", ":form_id", "account_usage" ], "variable": [ { "key": "form_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"error_code\": \"\",\n \"reason\": \"\",\n \"error_messages\": {}\n}", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-def85c87-44a6-4fdf-b677-23b77892dcc3" } ], "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-dfd8b2ad-8a22-481c-95cd-41d917892fff" } ], "id": "8247b9d6-d1dd-4c92-9a19-3654723f2187", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-8247b9d6-d1dd-4c92-9a19-3654723f2187" } ], "id": "ec8778e0-bbf1-45b7-86e4-28864c532c63", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-ec8778e0-bbf1-45b7-86e4-28864c532c63" } ], "id": "3f985c7b-3be2-45c1-bd45-73477fdb4424", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-3f985c7b-3be2-45c1-bd45-73477fdb4424" } ], "id": "4063f391-e6df-42fe-bc77-a0750fda68ca", "createdAt": "2026-07-28T01:27:36.000Z", "updatedAt": "2026-07-28T01:27:36.000Z", "uid": "35240-4063f391-e6df-42fe-bc77-a0750fda68ca" } ], "variable": [ { "key": "baseUrl", "value": "/onboarding" } ] }