{ "_": { "postman_id": "c601bbb8-a22e-4f5e-a5f2-a298b1711581" }, "item": [ { "id": "c86852e0-cd22-4363-bba0-cbd93aa53f7f", "name": "v1", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "499432a9-35a2-4adb-9ad8-a46d296ac177", "name": "configuration", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "9447cbe4-bec8-416d-9e03-12d277603aa4", "name": "classify-version", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fa7681c5-d1ed-4e79-aa77-c3cbf799ee1c", "name": "Get classify service version", "request": { "name": "Get classify service version", "description": { "content": "Get the current version of the classification service", "type": "text/plain" }, "url": { "path": [ "v1", "configuration", "classify-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/configuration/classify-version" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "d9fafa25-8458-4dae-8f34-c4c2e1f06b6e", "name": "Classification service version information", "originalRequest": { "url": { "path": [ "v1", "configuration", "classify-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/configuration/classify-version" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"version\": \"\",\n \"updated\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "bb293fe1-f6ab-4a1b-ae0a-957318a83a40", "name": "Classification service temporarily unavailable", "originalRequest": { "url": { "path": [ "v1", "configuration", "classify-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/configuration/classify-version" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "8f64efc7-19c4-4465-8b25-26b025f6418a", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "configuration", "classify-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/configuration/classify-version" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "9590f6bd-4334-42dc-8325-96b47d382e26", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "configuration", "classify-version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/configuration/classify-version" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dc19667a-085d-4af7-ae41-4177fe67f373", "name": "tags", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a22d5fc2-30ca-4475-851a-107dc53fdd6c", "name": "Get classification tags", "request": { "name": "Get classification tags", "description": { "content": "Retrieve the full dictionary of Level 1 and Level 2 classification tags", "type": "text/plain" }, "url": { "path": [ "v1", "configuration", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/configuration/tags" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "96b50d0f-a2a5-4bb6-8043-deafbef3cd4b", "name": "Classification tag hierarchy with Level 1 and Level 2 tags", "originalRequest": { "url": { "path": [ "v1", "configuration", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/configuration/tags" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"tags\": {\n \"credit\": {\n \"credit_sales\": [\n \"credit_sales_revenue\"\n ],\n \"credit_government\": [\n \"credit_government_support\"\n ]\n },\n \"debit\": {\n \"debit_wages\": [\n \"debit_wages_salary\"\n ],\n \"debit_rent\": [\n \"debit_rent_commercial\"\n ]\n }\n }\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "769b33da-7e83-4ca4-b640-431ace1ae16a", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "configuration", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/configuration/tags" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "4317f892-94e5-4b32-80b6-48fcd1cf0711", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "configuration", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/configuration/tags" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] }, { "id": "bebe1298-dfe4-4c8d-b339-ca29084d9e4c", "name": "customer", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a1e43d37-9a5e-4f71-9966-419362015461", "name": "Create new customer with ABN", "request": { "name": "Create new customer with ABN", "description": { "content": "Create a new customer with ABN. Will return existing customer if ABN already exists in our system. createdVia is portal-only: API-key callers may leave it out, and it is ignored for them. customerName is optional: send the entityName from GET /v1/abn/{abn} to name the customer after its registered entity.", "type": "text/plain" }, "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/customer" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"abn\": \"53004085616\",\n \"customerName\": \"B P AUSTRALIA PTY LTD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "7c56d9a5-9443-4ed1-87f6-4c95448429bf", "name": "Customer created successfully with customer ID", "originalRequest": { "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/customer" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"customerName\": \"B P AUSTRALIA PTY LTD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"customerId\": \"\",\n \"abn\": \"\",\n \"customerName\": \"\",\n \"displayName\": \"Phil - Blacktown\",\n \"attributes\": {\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n }\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "bdb5661e-094c-4c7c-a5c8-95a7c29cd17e", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/customer" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"customerName\": \"B P AUSTRALIA PTY LTD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "2ca87340-04a1-41fc-940b-7d5ecb7bf14d", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/customer" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"customerName\": \"B P AUSTRALIA PTY LTD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "ae49e080-dda9-4c04-91f0-fc1d780fe3d4", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/customer" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"abn\": \"\",\n \"customerName\": \"B P AUSTRALIA PTY LTD\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// auto-generated by postman-add-features", "if (pm.response.code === 200) {", " try {", " const value = pm.response.json().data.customerId;", " if (value) pm.collectionVariables.set(\"customerId\", value);", " } catch (e) { /* not JSON */ }", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3ed5649b-e234-4866-a61a-1ea0e050605d", "name": "Get customers for client", "request": { "name": "Get customers for client", "description": { "content": "Retrieve the client's customers. search matches the customer name, display name or ABN. sortBy accepts customerName (the default), abn or displayName; displayName sorts customers without one last in either direction.", "type": "text/plain" }, "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "A case-insensitive partial match on the customer name, display name or ABN. Spaces in an ABN are ignored.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": true, "description": { "content": "The field to sort by: customerName, abn or displayName. Defaults to customerName. displayName sorts customers without one last.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": true, "description": { "content": "The sort direction: asc or desc. Defaults to asc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/customer?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "df4d737c-8cf5-4dd7-989b-45230efd3e5c", "name": "List of customers", "originalRequest": { "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "A case-insensitive partial match on the customer name, display name or ABN. Spaces in an ABN are ignored.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": true, "description": { "content": "The field to sort by: customerName, abn or displayName. Defaults to customerName. displayName sorts customers without one last.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": true, "description": { "content": "The sort direction: asc or desc. Defaults to asc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/customer?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"customers\": [\n {\n \"customerId\": \"\",\n \"abn\": \"\",\n \"customerName\": \"\",\n \"attributes\": {\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n }\n },\n {\n \"customerId\": \"\",\n \"abn\": \"\",\n \"customerName\": \"\",\n \"attributes\": {\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n }\n }\n ],\n \"totalCount\": \"\",\n \"currentPage\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "ce082500-8093-498a-874e-f1a19a6db6d2", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "A case-insensitive partial match on the customer name, display name or ABN. Spaces in an ABN are ignored.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": true, "description": { "content": "The field to sort by: customerName, abn or displayName. Defaults to customerName. displayName sorts customers without one last.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": true, "description": { "content": "The sort direction: asc or desc. Defaults to asc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/customer?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "ffc62d98-070c-4e16-ad75-175d21cc5235", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "A case-insensitive partial match on the customer name, display name or ABN. Spaces in an ABN are ignored.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": true, "description": { "content": "The field to sort by: customerName, abn or displayName. Defaults to customerName. displayName sorts customers without one last.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": true, "description": { "content": "The sort direction: asc or desc. Defaults to asc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/customer?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "caa007ae-736a-410b-9c7e-2f4b215fca0f", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "A case-insensitive partial match on the customer name, display name or ABN. Spaces in an ABN are ignored.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": true, "description": { "content": "The field to sort by: customerName, abn or displayName. Defaults to customerName. displayName sorts customers without one last.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": true, "description": { "content": "The sort direction: asc or desc. Defaults to asc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/customer?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfab550e-ffe4-420a-b72c-fe002c586dca", "name": "{customerId}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5eecb458-ed70-49a3-890e-847ab3cf007e", "name": "Get customer", "request": { "name": "Get customer", "description": { "content": "Retrieve a customer by ID.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "7aebbc76-e3df-4add-a535-88493b74903c", "name": "Customer", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"customerId\": \"\",\n \"abn\": \"\",\n \"customerName\": \"\",\n \"displayName\": \"Phil - Blacktown\",\n \"attributes\": {\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n }\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "bc03bf99-2389-4b91-82d4-73161bffd998", "name": "Invalid customer ID format", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "a58b05fa-6faf-4c9e-8259-e02078726e16", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "ed2b73f0-44df-40a5-908f-be01f9fac419", "name": "Client lacks required scope: customers:read", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "aff74bd7-7189-48df-81c1-6fcc975be0fe", "name": "Customer not found", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5cbb60b8-d224-4e51-9b58-ea80104afab0", "name": "attributes", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "03cf1042-0878-4dd9-a7c2-a05330732459", "name": "Set customer attributes", "request": { "name": "Set customer attributes", "description": { "content": "Replace the attributes held for a customer. The body is the complete set, so an attribute omitted from it is cleared and repeating a call leaves the same values. Attributes are held per client: another client linked to the same ABN neither reads nor overwrites these values.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/attributes" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vedaScore\": 712.5,\n \"ownsProperty\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "39e149df-5a45-4a79-87fb-a4a0d5e0859e", "name": "The attributes now held for the customer", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/attributes" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "5d3a8025-8500-4929-93c5-8aef0c49441c", "name": "Unknown attribute name, or a value of the wrong type", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/attributes" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "49194610-a553-48c1-b04b-33946bc5ea81", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/attributes" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "ee65a891-4d91-41ed-ae51-b209d63825d9", "name": "Customer not found", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/attributes" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "b77f82fd-87a0-4f32-aa98-bede1f2f4b2e", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/attributes" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vedaScore\": \"\",\n \"ownsProperty\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dac9a393-6ce8-4eeb-85f2-b0321ecd9616", "name": "accounts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0599ea05-77e7-4bd6-9577-9d868aafba7f", "name": "{accountId}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "d9a93d1c-d8ca-4c32-9d53-b6222b50a66e", "name": "Delete an account and its related data", "request": { "name": "Delete an account and its related data", "description": { "content": "Permanently deletes the specified account data for the customer. Supports dry-run mode to preview the per-table deletion counts without removing any data.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "True returns the counts and changes nothing.", "type": "text/plain" }, "key": "dryRun", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "3a890438-5663-4a89-8566-ae8b12ea3ad3", "name": "Deletion result with per-table deleted record counts", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "True returns the counts and changes nothing.", "type": "text/plain" }, "key": "dryRun", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"accountId\": \"\",\n \"dryRun\": \"\",\n \"transactionsDeleted\": \"\",\n \"transactionSourceJobsDeleted\": \"\",\n \"cdrAccountsDeleted\": \"\",\n \"jobAccountsDeleted\": \"\",\n \"accountDeleted\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "9c1b9b9b-422c-4eaa-9c71-136cd61bff46", "name": "Invalid customer identifier, account identifier, or dryRun value", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "True returns the counts and changes nothing.", "type": "text/plain" }, "key": "dryRun", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "2f20b069-ed98-4bed-81f8-b9338b8d4aa7", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "True returns the counts and changes nothing.", "type": "text/plain" }, "key": "dryRun", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "3fd47ac5-af9e-48ea-aa38-604783c4ab95", "name": "The account was not found for this customer", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "True returns the counts and changes nothing.", "type": "text/plain" }, "key": "dryRun", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "198f9019-a6e3-4984-8dc7-4a2dc202928d", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "True returns the counts and changes nothing.", "type": "text/plain" }, "key": "dryRun", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10a8ff83-0565-447c-819c-18d483caca15", "name": "transactions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0d0e0478-83df-41dd-8dc8-ba29af53370c", "name": "Delete an account's transactions over a date range", "request": { "name": "Delete an account's transactions over a date range", "description": { "content": "Permanently deletes the client's transactions on one account whose date falls between dateFrom and dateTo inclusive. The account itself is retained. Both dates are required; there is no dry run and no cap on how many rows one call removes.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The first business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "The last business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateTo", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account whose transactions are deleted.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId/transactions?dateFrom=&dateTo=" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "57c59db2-f584-43ed-b7ee-747c165d6a08", "name": "Deletion result with the number of transactions deleted", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The first business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "The last business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateTo", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account whose transactions are deleted.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId/transactions?dateFrom=&dateTo=" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"accountId\": \"\",\n \"dateFrom\": \"\",\n \"dateTo\": \"\",\n \"transactionsDeleted\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "4f58946c-3e86-49d5-977f-7c6175dff1f8", "name": "Invalid customer identifier, account identifier, or date range", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The first business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "The last business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateTo", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account whose transactions are deleted.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId/transactions?dateFrom=&dateTo=" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "92417e40-d0b2-4477-8305-6de5d029bac7", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The first business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "The last business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateTo", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account whose transactions are deleted.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId/transactions?dateFrom=&dateTo=" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "781f6501-b6aa-4dab-989c-b1e2f801e11a", "name": "The account was not found for this customer", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The first business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "The last business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateTo", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account whose transactions are deleted.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId/transactions?dateFrom=&dateTo=" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "0757cc94-21f4-4461-8f53-206d26204a05", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "accounts", ":accountId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The first business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateFrom", "value": "" }, { "disabled": false, "description": { "content": "The last business date to delete, inclusive, as yyyy-MM-dd.", "type": "text/plain" }, "key": "dateTo", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The account whose transactions are deleted.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/accounts/:accountId/transactions?dateFrom=&dateTo=" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] } ], "event": [] }, { "id": "02d0dbea-da8c-40cc-a38e-a866174c73cf", "name": "transactions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fcc3e598-9771-43e3-b3a5-4a7afa32efad", "name": "Submit transaction batch for classification", "request": { "name": "Submit transaction batch for classification", "description": { "content": "Submit bank transactions for classification and enrichment.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"transactionDate\": \"2025-04-09\",\n \"amount\": 13167,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002916682025\",\n \"balance\": 33155.05\n },\n {\n \"transactionDate\": \"2025-04-09\",\n \"amount\": 85000,\n \"description\": \"Transfer from CommBank app Momentum\",\n \"balance\": 118155.05\n },\n {\n \"transactionDate\": \"2025-04-09\",\n \"amount\": -98675.26,\n \"description\": \"Multiple Transfer NetBank Batch Payment\",\n \"balance\": 19479.79\n },\n {\n \"transactionDate\": \"2025-04-08\",\n \"amount\": -101.65,\n \"description\": \"SMP*ABC Hand Carwash Blacktown AU Card xx3880 Value Date: 04/04/2025\",\n \"balance\": 23725.33\n },\n {\n \"transactionDate\": \"2025-04-08\",\n \"amount\": -122.18,\n \"description\": \"METRO BLACKTOWN SOUTH BLACKTOWN AU Card xx3880 Value Date: 04/04/2025\",\n \"balance\": 23603.15\n },\n {\n \"transactionDate\": \"2025-04-08\",\n \"amount\": -320.65,\n \"description\": \"Deputy deputy.com AU Card xx3880 Value Date: 03/04/2025\",\n \"balance\": 23282.5\n },\n {\n \"transactionDate\": \"2025-04-08\",\n \"amount\": 89000,\n \"description\": \"Transfer from NetBank Momentum\",\n \"balance\": 112282.5\n },\n {\n \"transactionDate\": \"2025-04-08\",\n \"amount\": -72214.45,\n \"description\": \"Multiple Transfer NetBank payroll\",\n \"balance\": 40068.05\n },\n {\n \"transactionDate\": \"2025-04-08\",\n \"amount\": -30255,\n \"description\": \"TAX OFFICE PAYMENTS NetBank BPAY 75556 2386105232182570 PAYG\",\n \"balance\": 9813.05\n },\n {\n \"transactionDate\": \"2025-04-08\",\n \"amount\": 2090,\n \"description\": \"Direct Credit 136890 Knauf Gypsum Pty 361942\",\n \"balance\": 11903.05\n },\n {\n \"transactionDate\": \"2025-04-08\",\n \"amount\": 8085,\n \"description\": \"Direct Credit 158824 AUSTRALIAN PET B 680\",\n \"balance\": 19988.05\n },\n {\n \"transactionDate\": \"2025-04-07\",\n \"amount\": -4231.6,\n \"description\": \"Transfer To ROC Hydraulics CommBank App Momentum\",\n \"balance\": 16809.31\n },\n {\n \"transactionDate\": \"2025-04-07\",\n \"amount\": 7017.67,\n \"description\": \"Direct Credit 158824 MINT BIOMINING P GJPY-000026\",\n \"balance\": 23826.98\n },\n {\n \"transactionDate\": \"2025-04-06\",\n \"amount\": -190,\n \"description\": \"XERO AU INV-42593476\",\n \"balance\": 21107.41\n },\n {\n \"transactionDate\": \"2025-04-06\",\n \"amount\": -66.5,\n \"description\": \"XERO AU INV-42602217\",\n \"balance\": 21040.91\n },\n {\n \"transactionDate\": \"2025-04-05\",\n \"amount\": -207.95,\n \"description\": \"WOOLWORTHS/28-30 OAK ST ROSEHILL AU Card xx3880 Value Date: 03/04/2025\",\n \"balance\": 21564.26\n },\n {\n \"transactionDate\": \"2025-04-05\",\n \"amount\": -47.4,\n \"description\": \"WOOLWORTHS/28-30 OAK ST ROSEHILL AU Card xx3880 Value Date: 03/04/2025\",\n \"balance\": 21516.86\n },\n {\n \"transactionDate\": \"2025-04-05\",\n \"amount\": -219.45,\n \"description\": \"Bronson Safety Pty Ltd 1300095701 AU Card xx3880 Value Date: 03/04/2025\",\n \"balance\": 21297.41\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": -3281.35,\n \"description\": \"BUNNINGS GROUP LTD HAWTHORN EAST AU Card xx3880 Value Date: 03/04/2025\",\n \"balance\": 49675.48\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": -149,\n \"description\": \"SQ *BONZER CHEMICAL SUPPL Hammondville Card xx3880 Value Date: 02/04/2025\",\n \"balance\": 49526.48\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": -422.19,\n \"description\": \"Google GSUITE_momentumind Sydney AU Card xx3880 Value Date: 01/04/2025\",\n \"balance\": 49104.29\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": 1895.3,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002915482025\",\n \"balance\": 50999.59\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": -24969.22,\n \"description\": \"Revenue NSW NetBank BPAY 27029 1457174405503250 March Payroll\",\n \"balance\": 26030.37\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": 17864.55,\n \"description\": \"Direct Credit 158824 MECFAB HOLDINGS 14195 Statement 55 (Page 3 of 20)\",\n \"balance\": 43894.92\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": 39131.95,\n \"description\": \"Direct Credit 371650 NFC\",\n \"balance\": 83026.87\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": -60000,\n \"description\": \"Transfer to CBA A/c CommBank app Momentum\",\n \"balance\": 23026.87\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": -1686.41,\n \"description\": \"Direct Debit 028424 WEX AUSTRALIA MOTORPSS 143242501\",\n \"balance\": 21340.46\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": -381.7,\n \"description\": \"Direct Debit 010752 FINANCE & LEASE XN38500400001\",\n \"balance\": 20958.76\n },\n {\n \"transactionDate\": \"2025-04-04\",\n \"amount\": 813.45,\n \"description\": \"Direct Credit 364049 Sara Lee Holding SARALEE\",\n \"balance\": 21772.21\n },\n {\n \"transactionDate\": \"2025-04-03\",\n \"amount\": 5802.5,\n \"description\": \"Fast Transfer From VALITEL VALET SERVICE VVS Co. Payment INV-14423\",\n \"balance\": 89991.01\n },\n {\n \"transactionDate\": \"2025-04-03\",\n \"amount\": -37034.18,\n \"description\": \"Direct Debit 481471 SuperChoice P/L PC030425-191510372\",\n \"balance\": 52956.83\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": -133.03,\n \"description\": \"EG GROUP/WINDSOR RD & MEL VINEYARD AU Card xx3880 Value Date: 31/03/2025 Statement 55 (Page 2 of 20)\",\n \"balance\": 45346.03\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": -201.63,\n \"description\": \"aliexpress North Sydney AU Card xx3880 Value Date: 31/03/2025\",\n \"balance\": 45144.4\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": -953.59,\n \"description\": \"PARCHEM WETHRILL PARK WETHERILL PAR AU Card xx3880 Value Date: 28/03/2025\",\n \"balance\": 44190.81\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": 1895.3,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002913752025\",\n \"balance\": 46086.11\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": 75000,\n \"description\": \"Transfer from NetBank Momentum\",\n \"balance\": 121086.11\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": -99685.31,\n \"description\": \"Multiple Transfer NetBank Batch Payment\",\n \"balance\": 21400.8\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": -40.4,\n \"description\": \"Transfer To Brett Jones NetBank reimbursement\",\n \"balance\": 21360.4\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": -247.19,\n \"description\": \"Transfer To Mohammed Munaf NetBank reimbursement\",\n \"balance\": 21113.21\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": 6102.77,\n \"description\": \"Direct Credit 136890 Knauf Gypsum Pty 361942\",\n \"balance\": 27215.98\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": 98,\n \"description\": \"Direct Credit 527668 RNSW R171791 Refund\",\n \"balance\": 27313.98\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": 356874.53,\n \"description\": \"Direct Credit 158824 AUSTRALIAN PET B 621\",\n \"balance\": 384188.51\n },\n {\n \"transactionDate\": \"2025-04-02\",\n \"amount\": -300000,\n \"description\": \"Transfer to CBA A/c CommBank app Momentum\",\n \"balance\": 84188.51\n },\n {\n \"transactionDate\": \"2025-04-01\",\n \"amount\": -22.6,\n \"description\": \"McDonalds 950195 WINDSOR AU Card xx3880 Value Date: 27/03/2025\",\n \"balance\": 132387.98\n },\n {\n \"transactionDate\": \"2025-04-01\",\n \"amount\": -141.41,\n \"description\": \"AMPOL ROUSE HILL ROUSE HILL AU Card xx3880 Value Date: 27/03/2025\",\n \"balance\": 132246.57\n },\n {\n \"transactionDate\": \"2025-04-01\",\n \"amount\": -34.61,\n \"description\": \"Transfer To Brett Jones CommBank App Reimbursement\",\n \"balance\": 132211.96\n },\n {\n \"transactionDate\": \"2025-04-01\",\n \"amount\": 1387.1,\n \"description\": \"Direct Credit 158824 RHOMBERG SERSA A 46050\",\n \"balance\": 133599.06\n },\n {\n \"transactionDate\": \"2025-04-01\",\n \"amount\": -73226.5,\n \"description\": \"Multiple Transfer NetBank payroll\",\n \"balance\": 60372.56\n },\n {\n \"transactionDate\": \"2025-04-01\",\n \"amount\": -31344,\n \"description\": \"TAX OFFICE PAYMENTS NetBank BPAY 75556 2386105232182570 PAYG\",\n \"balance\": 29028.56\n },\n {\n \"transactionDate\": \"2025-04-01\",\n \"amount\": 16450.5,\n \"description\": \"Direct Credit 136890 Knauf Gypsum Pty 361942\",\n \"balance\": 45479.06\n }\n ],\n \"accountName\": \"ACME Business Pty Ltd\",\n \"accountNumber\": \"12345678\",\n \"accountType\": \"Business Transaction Account\",\n \"bsb\": \"062001\",\n \"bankName\": \"Commonwealth Bank of Australia\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "84288bc7-eafc-4045-be4c-dfb57854c0a2", "name": "Job created successfully with job ID", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n }\n ],\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bsb\": \"\",\n \"bankName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"flow\": \"\",\n \"jobId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"totalReceivedTransactions\": \"\",\n \"totalProcessedTransactions\": \"\",\n \"totalDuplicateTransactions\": \"\",\n \"totalBatches\": \"\",\n \"completedBatches\": \"\",\n \"warnings\": {\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rowDiscrepancies\": [\n \"\",\n \"\"\n ],\n \"other\": [\n \"\",\n \"\"\n ],\n \"balanceChainMismatch\": {\n \"pdf\": \"\",\n \"computed\": \"\",\n \"delta\": \"\"\n }\n },\n \"tasks\": [\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n }\n ],\n \"fileWarnings\": [\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n },\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedDocuments\": [\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n },\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "243e9ea0-9025-4f05-968b-6c662fba41e9", "name": "Invalid request - too many transactions, Transactions list empty, Account details incomplete, supplied transactionId exceeds 100 characters, description missing or blank, or description exceeds 1000 characters (validated per account; the whole payload is rejected on the first invalid account). Also returned when the submission is larger than the client's whole hourly transaction limit, because a retry cannot succeed.", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n }\n ],\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bsb\": \"\",\n \"bankName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "2854788c-1883-4960-96f9-116eb80165b4", "name": "Insufficient permissions - Required scope: transactions:enrich", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n }\n ],\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bsb\": \"\",\n \"bankName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "0964636e-7e08-4b4e-9cb7-33cf0c839d1c", "name": "Transaction quota exceeded for this client. Retry-After gives the seconds to wait.", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n }\n ],\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bsb\": \"\",\n \"bankName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "1e070765-d433-4ac1-bf68-3967264585a2", "name": "The hourly transaction limit cannot be verified. Retry-After gives the seconds to wait.", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n }\n ],\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bsb\": \"\",\n \"bankName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "f886f4ed-b803-464f-8a11-054776901eed", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"transactionDate\": \"\",\n \"transactionId\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n },\n {\n \"transactionDate\": \"\",\n \"transactionId\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\"\n }\n ],\n \"accountName\": \"\",\n \"accountNumber\": \"\",\n \"accountType\": \"\",\n \"bsb\": \"\",\n \"bankName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// auto-generated by postman-add-features", "if (pm.response.code === 200) {", " try {", " const value = pm.response.json().data.jobId;", " if (value) pm.collectionVariables.set(\"jobId\", value);", " } catch (e) { /* not JSON */ }", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "44db306c-ceca-405d-a7a9-0c2d830476c4", "name": "Get all customer transactions", "request": { "name": "Get all customer transactions", "description": { "content": "Get all customer transactions with optional filtering by jobId, enrichment status, and pagination.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": true, "description": { "content": "The field to sort by. Omit it to sort by transaction date and sequence, ascending.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": true, "description": { "content": "The sort direction when sortBy is set. Defaults to desc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": true, "description": { "content": "Only return debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "" }, { "disabled": true, "description": { "content": "Only return debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 1 classification, for example debit_finance. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 1 classification, for example debit_finance. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 2 classification, for example debit_finance_asset-finance. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 2 classification, for example debit_finance_asset-finance. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this counterparty name, for example Commonwealth Bank. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this counterparty name, for example Commonwealth Bank. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "" }, { "disabled": false, "description": { "content": "Only return transactions on this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "54179680-d932-97e4-3531-ecf4c7ae1044" }, { "disabled": false, "description": { "content": "Only return transactions on this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions?jobId={{jobId}}&accountId=54179680-d932-97e4-3531-ecf4c7ae1044&accountId=94933613-3e91-d075-b62a-c761cef271db&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "b79aa9d3-4671-4482-8a3f-6f933d24e6b7", "name": "Transactions response containing list of customer's transactions", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": true, "description": { "content": "The field to sort by. Omit it to sort by transaction date and sequence, ascending.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": true, "description": { "content": "The sort direction when sortBy is set. Defaults to desc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": true, "description": { "content": "Only return debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 1 classification, for example debit_finance. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 2 classification, for example debit_finance_asset-finance. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this counterparty name, for example Commonwealth Bank. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "" }, { "disabled": false, "description": { "content": "Only return transactions on this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions?jobId={{jobId}}&accountId=94933613-3e91-d075-b62a-c761cef271db&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"accounts\": [\n {\n \"balance\": {\n \"currentBalance\": \"\",\n \"availableBalance\": \"\",\n \"accountLimit\": \"\"\n },\n \"latestTransactionDate\": \"\",\n \"latestSourcingDate\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"accountName\": \"\",\n \"accountType\": \"\",\n \"accountPurpose\": \"\",\n \"institutionId\": \"\",\n \"institutionName\": \"\",\n \"sourcedVia\": \"\"\n },\n {\n \"balance\": {\n \"currentBalance\": \"\",\n \"availableBalance\": \"\",\n \"accountLimit\": \"\"\n },\n \"latestTransactionDate\": \"\",\n \"latestSourcingDate\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"accountName\": \"\",\n \"accountType\": \"\",\n \"accountPurpose\": \"\",\n \"institutionId\": \"\",\n \"institutionName\": \"\",\n \"sourcedVia\": \"\"\n }\n ],\n \"transactions\": [\n {\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\",\n \"state\": 0,\n \"enrichment\": {\n \"classificationVersion\": \"\",\n \"level1\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level2\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level3\": {\n \"counterpartyId\": \"\",\n \"counterpartyABN\": \"\",\n \"counterpartyName\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n }\n },\n \"enrichmentSource\": \"\",\n \"transactionId\": \"\",\n \"customerId\": \"\",\n \"clientId\": \"\",\n \"suppliedId\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"jobId\": \"\",\n \"jobs\": [\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n },\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n }\n ],\n \"jobIds\": \"\",\n \"sourceType\": \"\"\n },\n {\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\",\n \"state\": 0,\n \"enrichment\": {\n \"classificationVersion\": \"\",\n \"level1\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level2\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level3\": {\n \"counterpartyId\": \"\",\n \"counterpartyABN\": \"\",\n \"counterpartyName\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n }\n },\n \"enrichmentSource\": \"\",\n \"transactionId\": \"\",\n \"customerId\": \"\",\n \"clientId\": \"\",\n \"suppliedId\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"jobId\": \"\",\n \"jobs\": [\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n },\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n }\n ],\n \"jobIds\": \"\",\n \"sourceType\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"currentPage\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "81c7b3ca-b6e0-4328-baff-65b7202a1b7b", "name": "Invalid request - see response message for details", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": true, "description": { "content": "The field to sort by. Omit it to sort by transaction date and sequence, ascending.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": true, "description": { "content": "The sort direction when sortBy is set. Defaults to desc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": true, "description": { "content": "Only return debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 1 classification, for example debit_finance. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 2 classification, for example debit_finance_asset-finance. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this counterparty name, for example Commonwealth Bank. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "" }, { "disabled": false, "description": { "content": "Only return transactions on this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions?jobId={{jobId}}&accountId=94933613-3e91-d075-b62a-c761cef271db&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "5b0e49e1-4003-4f2c-9d1d-029c94b1f9ba", "name": "Customer not found", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": true, "description": { "content": "The field to sort by. Omit it to sort by transaction date and sequence, ascending.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": true, "description": { "content": "The sort direction when sortBy is set. Defaults to desc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": true, "description": { "content": "Only return debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 1 classification, for example debit_finance. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 2 classification, for example debit_finance_asset-finance. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this counterparty name, for example Commonwealth Bank. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "" }, { "disabled": false, "description": { "content": "Only return transactions on this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions?jobId={{jobId}}&accountId=94933613-3e91-d075-b62a-c761cef271db&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "3f72e7b5-b860-489c-b4cc-d591b6e7d8ee", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": false, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": false, "description": { "content": "The field to sort by. Omit it to sort by transaction date and sequence, ascending.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": false, "description": { "content": "The sort direction when sortBy is set. Defaults to desc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": false, "description": { "content": "Only return debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 1 classification, for example debit_finance. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 2 classification, for example debit_finance_asset-finance. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this counterparty name, for example Commonwealth Bank. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "" }, { "disabled": false, "description": { "content": "Only return transactions on this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions?jobId={{jobId}}&enrichmentSource=&sortBy=&sortDirection=&transactionType=&accountId=94933613-3e91-d075-b62a-c761cef271db&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "5961f796-9bd4-4940-8555-ac4f81aebcb4", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": false, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": false, "description": { "content": "The field to sort by. Omit it to sort by transaction date and sequence, ascending.", "type": "text/plain" }, "key": "sortBy", "value": "" }, { "disabled": false, "description": { "content": "The sort direction when sortBy is set. Defaults to desc.", "type": "text/plain" }, "key": "sortDirection", "value": "" }, { "disabled": false, "description": { "content": "Only return debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 1 classification, for example debit_finance. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this Level 2 classification, for example debit_finance_asset-finance. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "" }, { "disabled": true, "description": { "content": "Only return transactions with this counterparty name, for example Commonwealth Bank. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "" }, { "disabled": false, "description": { "content": "Only return transactions on this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions?jobId={{jobId}}&enrichmentSource=&sortBy=&sortDirection=&transactionType=&accountId=94933613-3e91-d075-b62a-c761cef271db&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf2a295f-68a9-47ea-8933-98e3e861132d", "name": "multi-account", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "201a32eb-8adf-452e-a4aa-02997e517f20", "name": "Submit multi-account transaction batch for classification", "request": { "name": "Submit multi-account transaction batch for classification", "description": { "content": "Submit bank transactions for a batch of accounts (1 or many) for classification and enrichment.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-account" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"accountName\": \"ACME Business Pty Ltd Everyday\",\n \"accountNumber\": \"12345678\",\n \"bsb\": \"062-000\",\n \"accountType\": \"transaction\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-14\",\n \"amount\": 13167,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002916682025\",\n \"balance\": 33155.05\n },\n {\n \"transactionDate\": \"2026-01-13\",\n \"amount\": -320.65,\n \"description\": \"Deputy deputy.com AU Card xx3880\",\n \"balance\": 19987.4\n }\n ]\n },\n {\n \"accountName\": \"ACME Business Pty Ltd Savings\",\n \"accountNumber\": \"87654321\",\n \"bsb\": \"062-001\",\n \"accountType\": \"savings\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-15\",\n \"amount\": 85000,\n \"description\": \"Transfer from CommBank app Momentum\",\n \"balance\": 118155.05\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "9872241d-e809-4dcd-9973-7447d6c4adf8", "name": "Job created successfully with job ID", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-account" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"accountName\": \"ACME Business Pty Ltd Everyday\",\n \"accountNumber\": \"12345678\",\n \"bsb\": \"062-000\",\n \"accountType\": \"transaction\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-14\",\n \"amount\": 13167,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002916682025\",\n \"balance\": 33155.05\n },\n {\n \"transactionDate\": \"2026-01-13\",\n \"amount\": -320.65,\n \"description\": \"Deputy deputy.com AU Card xx3880\",\n \"balance\": 19987.4\n }\n ]\n },\n {\n \"accountName\": \"ACME Business Pty Ltd Savings\",\n \"accountNumber\": \"87654321\",\n \"bsb\": \"062-001\",\n \"accountType\": \"savings\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-15\",\n \"amount\": 85000,\n \"description\": \"Transfer from CommBank app Momentum\",\n \"balance\": 118155.05\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"flow\": \"\",\n \"jobId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"totalReceivedTransactions\": \"\",\n \"totalProcessedTransactions\": \"\",\n \"totalDuplicateTransactions\": \"\",\n \"totalBatches\": \"\",\n \"completedBatches\": \"\",\n \"warnings\": {\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rowDiscrepancies\": [\n \"\",\n \"\"\n ],\n \"other\": [\n \"\",\n \"\"\n ],\n \"balanceChainMismatch\": {\n \"pdf\": \"\",\n \"computed\": \"\",\n \"delta\": \"\"\n }\n },\n \"tasks\": [\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n }\n ],\n \"fileWarnings\": [\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n },\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedDocuments\": [\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n },\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "86faaa34-5fc1-4fcc-b13d-81b1d29663c5", "name": "Invalid request - too many accounts, too many transactions, Transactions list empty, Account details incomplete, duplicate accounts in the payload, supplied transactionId exceeds 100 characters, description missing or blank, or description exceeds 1000 characters (validated per account; the whole payload is rejected on the first invalid account). Also returned when the submission is larger than the client's whole hourly transaction limit, because a retry cannot succeed.", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-account" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"accountName\": \"ACME Business Pty Ltd Everyday\",\n \"accountNumber\": \"12345678\",\n \"bsb\": \"062-000\",\n \"accountType\": \"transaction\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-14\",\n \"amount\": 13167,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002916682025\",\n \"balance\": 33155.05\n },\n {\n \"transactionDate\": \"2026-01-13\",\n \"amount\": -320.65,\n \"description\": \"Deputy deputy.com AU Card xx3880\",\n \"balance\": 19987.4\n }\n ]\n },\n {\n \"accountName\": \"ACME Business Pty Ltd Savings\",\n \"accountNumber\": \"87654321\",\n \"bsb\": \"062-001\",\n \"accountType\": \"savings\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-15\",\n \"amount\": 85000,\n \"description\": \"Transfer from CommBank app Momentum\",\n \"balance\": 118155.05\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "90cdc916-0542-4c8f-b2a0-cf1f54d865fa", "name": "Insufficient permissions - Required scope: transactions:enrich", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-account" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"accountName\": \"ACME Business Pty Ltd Everyday\",\n \"accountNumber\": \"12345678\",\n \"bsb\": \"062-000\",\n \"accountType\": \"transaction\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-14\",\n \"amount\": 13167,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002916682025\",\n \"balance\": 33155.05\n },\n {\n \"transactionDate\": \"2026-01-13\",\n \"amount\": -320.65,\n \"description\": \"Deputy deputy.com AU Card xx3880\",\n \"balance\": 19987.4\n }\n ]\n },\n {\n \"accountName\": \"ACME Business Pty Ltd Savings\",\n \"accountNumber\": \"87654321\",\n \"bsb\": \"062-001\",\n \"accountType\": \"savings\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-15\",\n \"amount\": 85000,\n \"description\": \"Transfer from CommBank app Momentum\",\n \"balance\": 118155.05\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "4f490796-cfa0-4dc2-851d-d29fbd2798ca", "name": "Transaction quota exceeded for this client. Retry-After gives the seconds to wait.", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-account" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"accountName\": \"ACME Business Pty Ltd Everyday\",\n \"accountNumber\": \"12345678\",\n \"bsb\": \"062-000\",\n \"accountType\": \"transaction\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-14\",\n \"amount\": 13167,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002916682025\",\n \"balance\": 33155.05\n },\n {\n \"transactionDate\": \"2026-01-13\",\n \"amount\": -320.65,\n \"description\": \"Deputy deputy.com AU Card xx3880\",\n \"balance\": 19987.4\n }\n ]\n },\n {\n \"accountName\": \"ACME Business Pty Ltd Savings\",\n \"accountNumber\": \"87654321\",\n \"bsb\": \"062-001\",\n \"accountType\": \"savings\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-15\",\n \"amount\": 85000,\n \"description\": \"Transfer from CommBank app Momentum\",\n \"balance\": 118155.05\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d33f4bb3-610e-4af4-bbbc-d87656590807", "name": "The hourly transaction limit cannot be verified. Retry-After gives the seconds to wait.", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-account" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"accountName\": \"ACME Business Pty Ltd Everyday\",\n \"accountNumber\": \"12345678\",\n \"bsb\": \"062-000\",\n \"accountType\": \"transaction\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-14\",\n \"amount\": 13167,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002916682025\",\n \"balance\": 33155.05\n },\n {\n \"transactionDate\": \"2026-01-13\",\n \"amount\": -320.65,\n \"description\": \"Deputy deputy.com AU Card xx3880\",\n \"balance\": 19987.4\n }\n ]\n },\n {\n \"accountName\": \"ACME Business Pty Ltd Savings\",\n \"accountNumber\": \"87654321\",\n \"bsb\": \"062-001\",\n \"accountType\": \"savings\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-15\",\n \"amount\": 85000,\n \"description\": \"Transfer from CommBank app Momentum\",\n \"balance\": 118155.05\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "9f214704-bbe9-4e98-a493-085cb340a814", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-account" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"accountName\": \"ACME Business Pty Ltd Everyday\",\n \"accountNumber\": \"12345678\",\n \"bsb\": \"062-000\",\n \"accountType\": \"transaction\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-14\",\n \"amount\": 13167,\n \"description\": \"Direct Credit 158824 ARNOTT'S BISCUIT 339820002916682025\",\n \"balance\": 33155.05\n },\n {\n \"transactionDate\": \"2026-01-13\",\n \"amount\": -320.65,\n \"description\": \"Deputy deputy.com AU Card xx3880\",\n \"balance\": 19987.4\n }\n ]\n },\n {\n \"accountName\": \"ACME Business Pty Ltd Savings\",\n \"accountNumber\": \"87654321\",\n \"bsb\": \"062-001\",\n \"accountType\": \"savings\",\n \"bankName\": \"Commonwealth Bank\",\n \"transactions\": [\n {\n \"transactionDate\": \"2026-01-15\",\n \"amount\": 85000,\n \"description\": \"Transfer from CommBank app Momentum\",\n \"balance\": 118155.05\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "05cf18c8-b235-44d8-a182-33a66c411f39", "name": "download", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "68c0e57d-a1c3-4e2b-ada5-f27f7400d27e", "name": "Download customer transactions as file", "request": { "name": "Download customer transactions as file", "description": { "content": "Download customer transactions as JSON or CSV file. Supports same filtering as GetCustomerTransactions endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "transactions", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The file format: json or csv.", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/download?type=&jobId={{jobId}}&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "54a2fa62-662e-4814-ae70-36967d114451", "name": "Transaction file download as JSON", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The file format: json or csv.", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/download?type=&jobId={{jobId}}&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accounts\": [\n {\n \"balance\": {\n \"currentBalance\": \"\",\n \"availableBalance\": \"\",\n \"accountLimit\": \"\"\n },\n \"latestTransactionDate\": \"\",\n \"latestSourcingDate\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"accountName\": \"\",\n \"accountType\": \"\",\n \"accountPurpose\": \"\",\n \"institutionId\": \"\",\n \"institutionName\": \"\",\n \"sourcedVia\": \"\"\n },\n {\n \"balance\": {\n \"currentBalance\": \"\",\n \"availableBalance\": \"\",\n \"accountLimit\": \"\"\n },\n \"latestTransactionDate\": \"\",\n \"latestSourcingDate\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"accountName\": \"\",\n \"accountType\": \"\",\n \"accountPurpose\": \"\",\n \"institutionId\": \"\",\n \"institutionName\": \"\",\n \"sourcedVia\": \"\"\n }\n ],\n \"transactions\": [\n {\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\",\n \"state\": 0,\n \"enrichment\": {\n \"classificationVersion\": \"\",\n \"level1\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level2\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level3\": {\n \"counterpartyId\": \"\",\n \"counterpartyABN\": \"\",\n \"counterpartyName\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n }\n },\n \"enrichmentSource\": \"\",\n \"transactionId\": \"\",\n \"customerId\": \"\",\n \"clientId\": \"\",\n \"suppliedId\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"jobId\": \"\",\n \"jobs\": [\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n },\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n }\n ],\n \"jobIds\": \"\",\n \"sourceType\": \"\"\n },\n {\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\",\n \"state\": 0,\n \"enrichment\": {\n \"classificationVersion\": \"\",\n \"level1\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level2\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level3\": {\n \"counterpartyId\": \"\",\n \"counterpartyABN\": \"\",\n \"counterpartyName\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n }\n },\n \"enrichmentSource\": \"\",\n \"transactionId\": \"\",\n \"customerId\": \"\",\n \"clientId\": \"\",\n \"suppliedId\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"jobId\": \"\",\n \"jobs\": [\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n },\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n }\n ],\n \"jobIds\": \"\",\n \"sourceType\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"currentPage\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d4f950e7-85e8-4a23-9dd6-5abe217c659a", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The file format: json or csv.", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/download?type=&jobId={{jobId}}&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "f71c7970-b4be-4004-bae4-509e69f92aa1", "name": "Customer not found", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The file format: json or csv.", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/download?type=&jobId={{jobId}}&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "747c7f44-9100-42d3-87b9-0667d3a3eff7", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The file format: json or csv.", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/download?type=&jobId={{jobId}}&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "149f912d-575c-45de-8670-75f2c1927ac4", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The file format: json or csv.", "type": "text/plain" }, "key": "type", "value": "" }, { "disabled": true, "description": { "content": "Only return enriched (true) or unenriched (false) transactions. Omit it to return both.", "type": "text/plain" }, "key": "isEnriched", "value": "" }, { "disabled": false, "description": { "content": "Only read transactions from this job. Omit it to read every job.", "type": "text/plain" }, "key": "jobId", "value": "{{jobId}}" }, { "disabled": true, "description": { "content": "Only return transactions from this enrichment source. Omit it to return every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "" }, { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/download?type=&jobId={{jobId}}&page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "231c65fb-37a0-44d7-a17f-d290dbb99103", "name": "pdf", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "664b625b-ce4f-4c93-b268-e71350fb2a90", "name": "Submit a pdf bank statement for transaction extraction and classification", "request": { "name": "Submit a pdf bank statement for transaction extraction and classification", "description": { "content": "Submit a pdf bank statement for transaction extraction and classification.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "transactions", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/pdf" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Uploaded PDF file contents (binary).", "type": "text/plain" }, "key": "file", "type": "file" } ] }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "af9774ff-b804-4b1f-9a8c-e0b127c24fcf", "name": "Job created successfully with job ID", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/pdf" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Uploaded PDF file contents (binary).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"flow\": \"\",\n \"jobId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"totalReceivedTransactions\": \"\",\n \"totalProcessedTransactions\": \"\",\n \"totalDuplicateTransactions\": \"\",\n \"totalBatches\": \"\",\n \"completedBatches\": \"\",\n \"warnings\": {\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rowDiscrepancies\": [\n \"\",\n \"\"\n ],\n \"other\": [\n \"\",\n \"\"\n ],\n \"balanceChainMismatch\": {\n \"pdf\": \"\",\n \"computed\": \"\",\n \"delta\": \"\"\n }\n },\n \"tasks\": [\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n }\n ],\n \"fileWarnings\": [\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n },\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedDocuments\": [\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n },\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "4781e781-3e30-4a38-90a9-259279567d01", "name": "Insufficient permissions - Required scope: transactions:extract", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/pdf" }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "Uploaded PDF file contents (binary).", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// auto-generated by postman-add-features", "if (pm.response.code === 200) {", " try {", " const value = pm.response.json().data.jobId;", " if (value) pm.collectionVariables.set(\"jobId\", value);", " } catch (e) { /* not JSON */ }", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "93f389fd-2f02-4152-a856-02a8053e1a29", "name": "multi-pdf", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ad357838-f5e2-4a1b-9518-0eeb653ac11e", "name": "Submit multiple PDF bank statements for extraction", "request": { "name": "Submit multiple PDF bank statements for extraction", "description": { "content": "Creates a multi-file upload job. Returns a time-limited upload URL and blob names for direct upload of the files.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"files\": [\n {\n \"fileName\": \"cba-business-statement-2025-04.pdf\"\n },\n {\n \"fileName\": \"cba-business-statement-2025-05.pdf\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "287c0580-0f37-46ee-9be4-eb9b3887ade2", "name": "Upload job created with upload URL and blob names", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"files\": [\n {\n \"fileName\": \"\"\n },\n {\n \"fileName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"jobId\": \"\",\n \"uploadUrl\": \"\",\n \"files\": [\n {\n \"taskId\": \"\",\n \"blobName\": \"\"\n },\n {\n \"taskId\": \"\",\n \"blobName\": \"\"\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "817e3ee6-beeb-486d-bb2d-f3fa2d7d19b9", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"files\": [\n {\n \"fileName\": \"\"\n },\n {\n \"fileName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "125bf243-46f3-45fd-821d-beb55f6a7632", "name": "Insufficient permissions - Required scope: transactions:extract", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"files\": [\n {\n \"fileName\": \"\"\n },\n {\n \"fileName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "aba2cdfc-897c-46aa-beb8-a5cd2a6416b1", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"files\": [\n {\n \"fileName\": \"\"\n },\n {\n \"fileName\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// auto-generated by postman-add-features", "if (pm.response.code === 200) {", " try {", " const value = pm.response.json().data.jobId;", " if (value) pm.collectionVariables.set(\"jobId\", value);", " } catch (e) { /* not JSON */ }", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "08661816-1fd9-46a9-9371-7c0b10ca9197", "name": "seal", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "223e4f65-5725-4fae-a1e2-6b496119e0c0", "name": "Seal a multi-PDF upload job and trigger processing", "request": { "name": "Seal a multi-PDF upload job and trigger processing", "description": { "content": "Verifies all expected files are uploaded, starts the extraction tasks, and updates job status to Processing. Idempotent — safe to retry.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf", "seal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf/seal" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jobId\": \"{{jobId}}\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "acc6e191-3b19-4394-8cb9-091d7cd25f94", "name": "Job sealed and processing started", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf", "seal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf/seal" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jobId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"jobId\": \"\",\n \"status\": \"\",\n \"totalTasks\": \"\",\n \"extractionTasks\": \"\",\n \"enrichmentTasks\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "f627f01d-a34e-47a4-a084-9dcf742d1e77", "name": "Missing files or invalid job state", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf", "seal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf/seal" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jobId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "ddeda8ad-1204-4525-8fc1-d847ed45613c", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf", "seal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf/seal" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jobId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "fcc5c826-3326-4518-bdb2-b607ea12b17a", "name": "Job not found", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf", "seal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf/seal" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jobId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "73a9b468-52a3-4d11-afd6-27a3967f8b47", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "multi-pdf", "seal" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/multi-pdf/seal" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"jobId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// auto-generated by postman-add-features", "if (pm.response.code === 200) {", " try {", " const value = pm.response.json().data.jobId;", " if (value) pm.collectionVariables.set(\"jobId\", value);", " } catch (e) { /* not JSON */ }", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] }, { "id": "bcb915bd-387a-438c-b8f6-04ef8d6633b2", "name": "facets", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0dc75422-100a-4221-956e-57a3f3dc9445", "name": "Get customer transaction filter options", "request": { "name": "Get customer transaction filter options", "description": { "content": "Counts the customer's transactions per value of each filter. Each filter's options are narrowed by every other filter's selection, not its own. Each count equals the list endpoint's totalCount with that option selected in place of the filter's own selection. level1, level2 and level3 list __unclassified__ last, for transactions with no value, when its count is above 0 or it is selected. level3 returns the top 500 counterparties by count, plus __unclassified__, and sets truncated when more exist. accountId lists every account of the customer, or of the job when jobId is set, including accounts with a count of 0.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "transactions", "facets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only count enriched (true) or unenriched (false) transactions. Omit it to count both.", "type": "text/plain" }, "key": "isEnriched", "value": "true" }, { "disabled": false, "description": { "content": "Only count transactions from this job. Omit it to count every job.", "type": "text/plain" }, "key": "jobId", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d" }, { "disabled": false, "description": { "content": "Only count transactions from this enrichment source. Omit it to count every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "Cypher" }, { "disabled": false, "description": { "content": "Narrows the other facets to debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "debit" }, { "disabled": false, "description": { "content": "Narrows the other facets to debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "credit" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 1 classification. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 1 classification. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 2 classification. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 2 classification. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this counterparty name. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this counterparty name. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "54179680-d932-97e4-3531-ecf4c7ae1044" }, { "disabled": false, "description": { "content": "Narrows the other facets to this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/facets?isEnriched=true&jobId=360741c8-d0bd-0c6a-7b8f-c4072bf6f76d&enrichmentSource=Cypher&transactionType=debit&transactionType=credit&level1=string&level1=string&level2=string&level2=string&level3=string&level3=string&accountId=54179680-d932-97e4-3531-ecf4c7ae1044&accountId=94933613-3e91-d075-b62a-c761cef271db" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "b9793cc6-cc2d-4a9c-b2f8-d931d4512de3", "name": "Each filter's options, ordered by count descending, then value", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "facets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only count enriched (true) or unenriched (false) transactions. Omit it to count both.", "type": "text/plain" }, "key": "isEnriched", "value": "true" }, { "disabled": false, "description": { "content": "Only count transactions from this job. Omit it to count every job.", "type": "text/plain" }, "key": "jobId", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d" }, { "disabled": false, "description": { "content": "Only count transactions from this enrichment source. Omit it to count every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "Cypher" }, { "disabled": false, "description": { "content": "Narrows the other facets to debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "credit" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 1 classification. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 2 classification. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this counterparty name. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/facets?isEnriched=true&jobId=360741c8-d0bd-0c6a-7b8f-c4072bf6f76d&enrichmentSource=Cypher&transactionType=credit&level1=string&level2=string&level3=string&accountId=94933613-3e91-d075-b62a-c761cef271db" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"facets\": [\n {\n \"name\": \"string\",\n \"truncated\": false,\n \"options\": [\n {\n \"value\": \"string\",\n \"count\": 2015\n },\n {\n \"value\": \"string\",\n \"count\": 3831\n }\n ]\n },\n {\n \"name\": \"string\",\n \"truncated\": true,\n \"options\": [\n {\n \"value\": \"string\",\n \"count\": 106\n },\n {\n \"value\": \"string\",\n \"count\": 2076\n }\n ]\n }\n ]\n },\n \"message\": null,\n \"errors\": null\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "3a3ede90-988c-4e94-8b8f-9f033510614e", "name": "Invalid request - see response message for details", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "facets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only count enriched (true) or unenriched (false) transactions. Omit it to count both.", "type": "text/plain" }, "key": "isEnriched", "value": "true" }, { "disabled": false, "description": { "content": "Only count transactions from this job. Omit it to count every job.", "type": "text/plain" }, "key": "jobId", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d" }, { "disabled": false, "description": { "content": "Only count transactions from this enrichment source. Omit it to count every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "Cypher" }, { "disabled": false, "description": { "content": "Narrows the other facets to debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "credit" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 1 classification. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 2 classification. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this counterparty name. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/facets?isEnriched=true&jobId=360741c8-d0bd-0c6a-7b8f-c4072bf6f76d&enrichmentSource=Cypher&transactionType=credit&level1=string&level2=string&level3=string&accountId=94933613-3e91-d075-b62a-c761cef271db" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "e79ab76c-ca7b-4139-bd3f-b273eb5c60a5", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "facets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only count enriched (true) or unenriched (false) transactions. Omit it to count both.", "type": "text/plain" }, "key": "isEnriched", "value": "true" }, { "disabled": false, "description": { "content": "Only count transactions from this job. Omit it to count every job.", "type": "text/plain" }, "key": "jobId", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d" }, { "disabled": false, "description": { "content": "Only count transactions from this enrichment source. Omit it to count every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "Cypher" }, { "disabled": false, "description": { "content": "Narrows the other facets to debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "credit" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 1 classification. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 2 classification. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this counterparty name. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/facets?isEnriched=true&jobId=360741c8-d0bd-0c6a-7b8f-c4072bf6f76d&enrichmentSource=Cypher&transactionType=credit&level1=string&level2=string&level3=string&accountId=94933613-3e91-d075-b62a-c761cef271db" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "d926da57-46e2-4a74-ad43-b5968e33f33c", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "facets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only count enriched (true) or unenriched (false) transactions. Omit it to count both.", "type": "text/plain" }, "key": "isEnriched", "value": "true" }, { "disabled": false, "description": { "content": "Only count transactions from this job. Omit it to count every job.", "type": "text/plain" }, "key": "jobId", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d" }, { "disabled": false, "description": { "content": "Only count transactions from this enrichment source. Omit it to count every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "Cypher" }, { "disabled": false, "description": { "content": "Narrows the other facets to debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "credit" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 1 classification. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 2 classification. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this counterparty name. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/facets?isEnriched=true&jobId=360741c8-d0bd-0c6a-7b8f-c4072bf6f76d&enrichmentSource=Cypher&transactionType=credit&level1=string&level2=string&level3=string&accountId=94933613-3e91-d075-b62a-c761cef271db" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "1d14f59e-9d7d-4f9f-8cfd-439e4c1dcf80", "name": "Customer not found, or the feature is not enabled", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "transactions", "facets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only count enriched (true) or unenriched (false) transactions. Omit it to count both.", "type": "text/plain" }, "key": "isEnriched", "value": "true" }, { "disabled": false, "description": { "content": "Only count transactions from this job. Omit it to count every job.", "type": "text/plain" }, "key": "jobId", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d" }, { "disabled": false, "description": { "content": "Only count transactions from this enrichment source. Omit it to count every source.", "type": "text/plain" }, "key": "enrichmentSource", "value": "Cypher" }, { "disabled": false, "description": { "content": "Narrows the other facets to debit or credit transactions. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "transactionType", "value": "credit" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 1 classification. Pass __unclassified__ for transactions with no Level 1. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level1", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this Level 2 classification. Pass __unclassified__ for transactions with no Level 2. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level2", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this counterparty name. Pass __unclassified__ for transactions with no counterparty. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "level3", "value": "string" }, { "disabled": false, "description": { "content": "Narrows the other facets to this account. Repeat it to match any of the values, up to 100. Filters combine with AND.", "type": "text/plain" }, "key": "accountId", "value": "94933613-3e91-d075-b62a-c761cef271db" } ], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "360741c8-d0bd-0c6a-7b8f-c4072bf6f76d", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/transactions/facets?isEnriched=true&jobId=360741c8-d0bd-0c6a-7b8f-c4072bf6f76d&enrichmentSource=Cypher&transactionType=credit&level1=string&level2=string&level3=string&accountId=94933613-3e91-d075-b62a-c761cef271db" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] }, { "id": "e82beb3b-559a-48c4-aff8-77c2204929ea", "name": "reports", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "54165227-df98-49bb-8beb-2b59224ee1b7", "name": "Get the customer report bundle", "request": { "name": "Get the customer report bundle", "description": { "content": "Returns the completeness, risk and aggregate reports for a customer in a single call. Each report carries a status (pending, ready or stale) and a failed flag; ready and stale reports also include their data and the timestamp they were generated.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "050ee520-d95f-46e7-81d8-98215baac362", "name": "The customer's current report bundle", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"completeness\": {\n \"status\": \"pending\",\n \"failed\": \"\",\n \"generatedAt\": \"\",\n \"data\": {\n \"completenessId\": \"\",\n \"customerId\": \"\",\n \"generatedTimestamp\": \"\",\n \"summary\": {\n \"completenessScore\": \"\",\n \"completenessTier\": \"\",\n \"totalMissingness\": \"\"\n },\n \"rankedFeatures\": [\n {\n \"rank\": \"\",\n \"featureName\": \"\",\n \"comparisonToBenchmark\": \"\",\n \"contributionToMissingness\": \"\",\n \"actionResponse\": \"\"\n },\n {\n \"rank\": \"\",\n \"featureName\": \"\",\n \"comparisonToBenchmark\": \"\",\n \"contributionToMissingness\": \"\",\n \"actionResponse\": \"\"\n }\n ],\n \"dataQualityAssessment\": {\n \"coverage\": \"\"\n },\n \"recommendedActions\": [\n {\n \"description\": \"\",\n \"priority\": \"\"\n },\n {\n \"description\": \"\",\n \"priority\": \"\"\n }\n ],\n \"bankAccounts\": [\n {\n \"bankAccountId\": \"\",\n \"bsb\": \"\",\n \"bank\": \"\",\n \"accountNumber\": \"\",\n \"accountPurpose\": \"\",\n \"sourceOfAwareness\": \"\",\n \"dataStatus\": \"\",\n \"coverage\": {\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"largestGapDays\": \"\",\n \"percentDaysMissing\": \"\"\n }\n },\n {\n \"bankAccountId\": \"\",\n \"bsb\": \"\",\n \"bank\": \"\",\n \"accountNumber\": \"\",\n \"accountPurpose\": \"\",\n \"sourceOfAwareness\": \"\",\n \"dataStatus\": \"\",\n \"coverage\": {\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"largestGapDays\": \"\",\n \"percentDaysMissing\": \"\"\n }\n }\n ]\n }\n },\n \"risk\": {\n \"status\": \"pending\",\n \"failed\": \"\",\n \"generatedAt\": \"\",\n \"data\": {\n \"value\": \"\",\n \"rating\": \"\",\n \"features\": {\n \"arb\": \"\",\n \"averageSales\": \"\",\n \"dishonourCount\": \"\",\n \"averageTaxPayment\": \"\",\n \"averageFinancialCount\": \"\"\n },\n \"shapleyValues\": {},\n \"transactionsMetadata\": {\n \"earliestTransactionDate\": \"\",\n \"latestTransactionDate\": \"\",\n \"transactionCount\": \"\"\n },\n \"timeSeries\": {\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"frequency\": \"\",\n \"windowDays\": \"\",\n \"values\": [\n {\n \"date\": \"\",\n \"pd\": \"\",\n \"rating\": \"\",\n \"features\": {\n \"arb\": \"\",\n \"averageSales\": \"\",\n \"dishonourCount\": \"\",\n \"averageTaxPayment\": \"\",\n \"averageFinancialCount\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ]\n },\n {\n \"date\": \"\",\n \"pd\": \"\",\n \"rating\": \"\",\n \"features\": {\n \"arb\": \"\",\n \"averageSales\": \"\",\n \"dishonourCount\": \"\",\n \"averageTaxPayment\": \"\",\n \"averageFinancialCount\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"pdConfidenceScore\": \"\",\n \"pdConfidenceRating\": \"\"\n }\n },\n \"aggregate\": {\n \"status\": \"pending\",\n \"failed\": \"\",\n \"generatedAt\": \"\",\n \"data\": {\n \"tables\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"hierarchy\": 0,\n \"type\": 0,\n \"values\": {}\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"hierarchy\": 0,\n \"type\": 0,\n \"values\": {}\n }\n ]\n }\n }\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "214a6313-c216-4151-a35d-864faecbe0fa", "name": "Insufficient Permissions. Required scope: customer:reports", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "dd7c38ad-6920-4d14-b35e-5ebaa51f7dca", "name": "Customer not found", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "c649df19-aefa-486f-9657-ae2c5ef7346b", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f01df1ea-e70e-4b42-99ed-47f84142d159", "name": "refresh", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "aee9e556-1535-4dab-8f59-4959d9853c4d", "name": "Refresh the customer report bundle", "request": { "name": "Refresh the customer report bundle", "description": { "content": "Starts an on-demand recompute of the customer's completeness, risk and aggregate reports over all of the customer's enriched transactions. Returns a job id immediately; poll the job status endpoint until the job completes, then read the current reports from the reports endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "reports", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports/refresh" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "5823833c-8686-4f54-b916-6ace377a6763", "name": "Report refresh accepted; poll the returned job id for completion", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports/refresh" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"flow\": \"\",\n \"jobId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"totalReceivedTransactions\": \"\",\n \"totalProcessedTransactions\": \"\",\n \"totalDuplicateTransactions\": \"\",\n \"totalBatches\": \"\",\n \"completedBatches\": \"\",\n \"warnings\": {\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rowDiscrepancies\": [\n \"\",\n \"\"\n ],\n \"other\": [\n \"\",\n \"\"\n ],\n \"balanceChainMismatch\": {\n \"pdf\": \"\",\n \"computed\": \"\",\n \"delta\": \"\"\n }\n },\n \"tasks\": [\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n }\n ],\n \"fileWarnings\": [\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n },\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedDocuments\": [\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n },\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "1ab7e5a9-a2d2-405b-9744-6611cc786642", "name": "Insufficient Permissions. Required scope: customer:riskscore", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports/refresh" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "3fb41f17-0838-46b5-aada-8a01ccec42e2", "name": "The customer does not exist or is not owned by the caller", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports/refresh" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d9c9063d-2d89-4f1f-959c-943936df19a5", "name": "A job is already in progress for this customer", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports/refresh" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "e1df6f8e-6f54-4c6a-813e-f12b1c5426c2", "name": "The customer has no enriched transactions to report on", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports/refresh" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "f937026b-e71e-4cc1-ab80-d10ca6cfc683", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "reports", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/reports/refresh" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] }, { "id": "ca90bbf8-19f3-41a4-8908-c9b159e28ab7", "name": "invites", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4c9082e8-6596-4de7-afbf-bd1dffffc571", "name": "Invite a customer user", "request": { "name": "Invite a customer user", "description": { "content": "Asks for the supplied address to be given access to the customer. If the customer has no users yet, the invitation is emailed straight to that address. If it already has one, the invitation is held and an approval request goes to the customer's longest-standing user instead; the invited address hears nothing until they approve. Accepted asynchronously either way; the outcome in the response says which path it took, and does not confirm delivery. An optional displayName sets your private name for the customer. It is written after the invite is sent, so a 202 does not confirm it was stored; omitting it, or sending a blank value, keeps the name you hold now. The customer, the approver and the invitee never see it.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to invite the user to.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/invites" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"jane.citizen@example.com.au\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Citizen\",\n \"mobileNumber\": \"0412 345 678\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "2463d120-4323-4e4e-a7b4-efc65369f97e", "name": "Invite initiated. \"sent\" means the invitation was emailed to the address, \"approval_requested\" means an existing user of the customer must admit the address first and it has heard nothing yet.", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to invite the user to.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/invites" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobileNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"outcome\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "887c3369-ee3c-473a-ae85-51a0b471a9b9", "name": "Request body is missing or fails validation", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to invite the user to.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/invites" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobileNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d58d87e0-91a3-42e1-95a0-e4b9d8641e42", "name": "No such customer for this client", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to invite the user to.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/invites" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobileNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "27235d03-f558-4498-bb95-83c15142c2ce", "name": "The address already has an account; or the customer has no users yet and an invitation to a different address is already outstanding — only one may be outstanding while the customer has nobody who can approve; or this client already holds an invitation the customer accepted, which only an expired or rejected one may replace. The message in the response says which.", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to invite the user to.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/invites" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobileNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "db16c1a7-edd3-43a3-b0bd-60bd7d5295ff", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to invite the user to.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/invites" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobileNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "1d5de24d-51a6-4de1-beaa-bb68831f990b", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "invites" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to invite the user to.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/invites" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobileNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "844773c4-1365-4bab-a30c-d9e5423f77b1", "name": "decision-policies", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a99f4ec2-eebd-4425-a8b8-83b62b29e7c9", "name": "{slug}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0715158f-48d6-419c-a20c-7aa8c9db68aa", "name": "evaluate", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ae591762-c929-4526-b8a3-f524e062498d", "name": "Evaluate decision policy", "request": { "name": "Evaluate decision policy", "description": { "content": "Apply a decision policy to a customer and receive the verdict. Supply a value for every input the policy declares; the policy's steps are applied in order and the first step whose condition matches returns its outcome and the recommended actions of its matched rules, falling back to the policy's default outcome when none match. The response also carries computedLimits, always present and empty when the policy declares no limit. A broker client never receives indicators, metrics, a computed limit's capped and uncappedAmount, or any reason's metricIds: those keys are omitted from its response.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "decision-policies", ":slug", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to decide on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/decision-policies/:slug/evaluate" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputs\": {\n \"requested_amount\": 50000\n },\n \"attributeOverrides\": {\n \"vedaScore\": 712.5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "a3061474-c359-4e09-97af-076823d682f7", "name": "The policy's verdict", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "decision-policies", ":slug", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to decide on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/decision-policies/:slug/evaluate" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputs\": {\n \"requested_amount\": 50000\n },\n \"attributeOverrides\": {\n \"vedaScore\": 712.5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"verdict\": {\n \"outcome\": \"blocked\",\n \"recommendedActions\": [\n \"\",\n \"\"\n ],\n \"reasons\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"metricIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"metricIds\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"computedLimits\": [\n {\n \"kind\": \"computed\",\n \"productId\": \"\",\n \"amount\": \"\",\n \"capped\": \"\",\n \"uncappedAmount\": \"\"\n },\n {\n \"kind\": \"computed\",\n \"productId\": \"\",\n \"amount\": \"\",\n \"capped\": \"\",\n \"uncappedAmount\": \"\"\n }\n ],\n \"products\": [\n {\n \"productId\": \"\",\n \"slug\": \"\",\n \"name\": \"\"\n },\n {\n \"productId\": \"\",\n \"slug\": \"\",\n \"name\": \"\"\n }\n ],\n \"attributes\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"source\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"source\": \"\"\n }\n ],\n \"indicators\": [\n {\n \"kind\": \"reading\",\n \"metricId\": \"\",\n \"value\": \"\",\n \"format\": \"ratio\"\n },\n {\n \"kind\": \"reading\",\n \"metricId\": \"\",\n \"value\": \"\",\n \"format\": \"integer\"\n }\n ],\n \"metrics\": [\n {\n \"metricId\": \"\",\n \"name\": \"\"\n },\n {\n \"metricId\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "3d42ea13-882a-441d-a5ab-c35adc48e211", "name": "Invalid request body, customer id, or supplied inputs", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "decision-policies", ":slug", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to decide on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/decision-policies/:slug/evaluate" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputs\": {\n \"requested_amount\": 50000\n },\n \"attributeOverrides\": {\n \"vedaScore\": 712.5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "fb514a47-2e9b-4e53-9569-c9573e60a42e", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "decision-policies", ":slug", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to decide on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/decision-policies/:slug/evaluate" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputs\": {\n \"requested_amount\": 50000\n },\n \"attributeOverrides\": {\n \"vedaScore\": 712.5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "96a29c73-a25f-49bb-8406-2faa629faac2", "name": "Client lacks required scope: decision-policies:evaluate", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "decision-policies", ":slug", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to decide on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/decision-policies/:slug/evaluate" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputs\": {\n \"requested_amount\": 50000\n },\n \"attributeOverrides\": {\n \"vedaScore\": 712.5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "aa515a53-5f04-43f1-8fac-88877afe1e13", "name": "Customer or decision policy not found", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "decision-policies", ":slug", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to decide on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/decision-policies/:slug/evaluate" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputs\": {\n \"requested_amount\": 50000\n },\n \"attributeOverrides\": {\n \"vedaScore\": 712.5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "53194dd9-1ed5-4c00-a429-2bae1a1f74d7", "name": "The policy could not be applied to this customer", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "decision-policies", ":slug", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to decide on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" }, { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "slug" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/decision-policies/:slug/evaluate" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputs\": {\n \"requested_amount\": 50000\n },\n \"attributeOverrides\": {\n \"vedaScore\": 712.5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "e90c60d9-40bd-4807-8d9e-6528ecb76860", "name": "The policy could not be evaluated", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "decision-policies", ":slug", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer to decide on.", "type": "text/plain" }, "type": "any", "value": "d02741fd-856d-5065-65cb-11ebcf270aef", "key": "customerId" }, { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "slug" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/decision-policies/:slug/evaluate" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inputs\": {\n \"requested_amount\": 50000\n },\n \"attributeOverrides\": {\n \"vedaScore\": 712.5\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] } ], "event": [] }, { "id": "ede3c968-2aa2-4658-ab24-c52f2a22eaf5", "name": "completeness", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1eb575e5-9fb7-49a9-b01d-740dd069a0b9", "name": "feedback", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "0868cc63-e05b-4cb5-8971-91e520d78d98", "name": "Submit completeness score feedback", "request": { "name": "Submit completeness score feedback", "description": { "content": "Records a lender's feedback on a customer's completeness score: whether anything is missing from it, and either what the lender bases \"the score looks right\" on or which kinds of account are missing, with an optional note. isAnythingMissing picks the pathway, and each field states the rules that depend on it. Each submission is stored as a new record. Callable by an API key only.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "completeness", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "7c6eac12-b0d9-dff6-14da-8d1f128524af", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/completeness/feedback" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"classifyVersion\": \"string\",\n \"currentCompletenessScore\": 6027.411536949944,\n \"isAnythingMissing\": false,\n \"basedOn\": \"documents_match\",\n \"note\": \"FY25 P&L revenue within 3% of connected inflows\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "7866cb79-712e-4bb6-9226-9f9026e6a033", "name": "The answers were recorded; the id names them for support", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "completeness", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "7c6eac12-b0d9-dff6-14da-8d1f128524af", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/completeness/feedback" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"classifyVersion\": \"string\",\n \"currentCompletenessScore\": 6027.411536949944,\n \"isAnythingMissing\": false,\n \"basedOn\": \"documents_match\",\n \"note\": \"FY25 P&L revenue within 3% of connected inflows\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"completenessFeedbackId\": \"08791dac-7290-3ad6-3e2a-1599e48b9bdd\"\n },\n \"message\": null,\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "2a5142d7-6337-405d-ba7e-d4ae4985d394", "name": "Invalid request - a required answer is missing, an answer is not in its list or not allowed on the pathway isAnythingMissing picks, a missing account type is repeated or dont_know is picked with another type, an unknown field was sent, or a field is too long. The message names the rule broken.", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "completeness", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "7c6eac12-b0d9-dff6-14da-8d1f128524af", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/completeness/feedback" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"classifyVersion\": \"string\",\n \"currentCompletenessScore\": 6027.411536949944,\n \"isAnythingMissing\": false,\n \"basedOn\": \"documents_match\",\n \"note\": \"FY25 P&L revenue within 3% of connected inflows\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "053e7c7b-02ae-4cb5-859b-6e942baf93b6", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "completeness", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "7c6eac12-b0d9-dff6-14da-8d1f128524af", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/completeness/feedback" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"classifyVersion\": \"string\",\n \"currentCompletenessScore\": 6027.411536949944,\n \"isAnythingMissing\": false,\n \"basedOn\": \"documents_match\",\n \"note\": \"FY25 P&L revenue within 3% of connected inflows\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "1dde98ef-c783-4a92-abee-f3c6084dd91f", "name": "Insufficient Permissions. Required scope: completeness-feedback:write", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "completeness", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "7c6eac12-b0d9-dff6-14da-8d1f128524af", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/completeness/feedback" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"classifyVersion\": \"string\",\n \"currentCompletenessScore\": 6027.411536949944,\n \"isAnythingMissing\": false,\n \"basedOn\": \"documents_match\",\n \"note\": \"FY25 P&L revenue within 3% of connected inflows\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "c2937593-2adf-4759-abde-2854e4df34c1", "name": "No such customer for this client", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "completeness", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "7c6eac12-b0d9-dff6-14da-8d1f128524af", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/completeness/feedback" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"classifyVersion\": \"string\",\n \"currentCompletenessScore\": 6027.411536949944,\n \"isAnythingMissing\": false,\n \"basedOn\": \"documents_match\",\n \"note\": \"FY25 P&L revenue within 3% of connected inflows\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] }, { "id": "88c1b1e6-d7b3-4a13-b7f5-6fca297ae89a", "name": "display-name", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c6b6b35d-745e-4160-84f5-fc8e1ec70a6e", "name": "Set customer display name", "request": { "name": "Set customer display name", "description": { "content": "Set or clear your private name for a customer. The name is trimmed, and a blank, null or omitted value clears it. Display names are held per client: another client linked to the same ABN neither reads nor overwrites yours, and the customer never sees it.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", ":customerId", "display-name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/display-name" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"Phil - Blacktown\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "10de8507-318b-4dd9-b383-9c45e06f089c", "name": "The display name now held for the customer, or null when cleared", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "display-name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/display-name" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"Phil - Blacktown\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"displayName\": \"Phil - Blacktown\"\n },\n \"message\": null,\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "60a52856-b393-41be-a21d-6d58ea015895", "name": "Display name longer than 100 characters, or containing a control character", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "display-name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/display-name" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"Phil - Blacktown\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "1cad30f2-a0fc-40cf-90dd-9e0a69bf58a1", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "display-name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/display-name" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"Phil - Blacktown\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "1bc6f6e3-6a38-485a-9702-cde04e945da7", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "display-name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/display-name" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"Phil - Blacktown\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "c18b4d56-157a-4231-90b3-9246f0befcbd", "name": "Customer not found", "originalRequest": { "url": { "path": [ "v1", "customer", ":customerId", "display-name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer the request acts on.", "type": "text/plain" }, "type": "any", "value": "{{customerId}}", "key": "customerId" } ], "raw": "{{baseUrl}}/v1/customer/:customerId/display-name" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"Phil - Blacktown\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] }, { "id": "a4d9388c-b009-4a4a-8f01-87549b70a375", "name": "abn", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "89048f78-9ace-4577-ba2b-a0ead07c0f0e", "name": "{abn}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8af8dc50-1a2e-46fe-9e4f-aa0a958ad00b", "name": "Get customer by ABN", "request": { "name": "Get customer by ABN", "description": { "content": "Retrieve one of the client's customers by ABN.", "type": "text/plain" }, "url": { "path": [ "v1", "customer", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer's ABN: 11 digits, no spaces.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/customer/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "b68a69dc-04f6-44d5-bea7-1eb004c58bff", "name": "Customer", "originalRequest": { "url": { "path": [ "v1", "customer", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer's ABN: 11 digits, no spaces.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/customer/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"customerId\": \"524ba9bc-06e7-417e-bd54-b99785f5194a\",\n \"abn\": \"90551661605\",\n \"customerName\": \"Blacktown Hydraulics Pty Ltd\",\n \"displayName\": \"Phil - Blacktown\",\n \"attributes\": {\n \"vedaScore\": 712.5,\n \"ownsProperty\": true\n }\n },\n \"message\": null,\n \"errors\": null\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "a4f253f4-06b0-414e-a8eb-4b83f2d5e63f", "name": "ABN is not 11 digits", "originalRequest": { "url": { "path": [ "v1", "customer", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer's ABN: 11 digits, no spaces.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/customer/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "0a8af292-9ea6-44d6-b293-4d4ffa1a0de5", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "customer", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer's ABN: 11 digits, no spaces.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/customer/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "b8e4ecfd-3639-446a-bd37-023bc48b3aa2", "name": "Client lacks required scope: customers:read", "originalRequest": { "url": { "path": [ "v1", "customer", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer's ABN: 11 digits, no spaces.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/customer/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "4eba3a1d-67c7-4468-b19a-92bff323c21d", "name": "No customer with this ABN for the client", "originalRequest": { "url": { "path": [ "v1", "customer", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The customer's ABN: 11 digits, no spaces.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/customer/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] } ], "event": [] }, { "id": "367def7b-2ea6-4899-ab7d-aab06684d7eb", "name": "decision-policies", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "62e41e31-3d69-4f81-94d4-d5369b25259a", "name": "List decision policies", "request": { "name": "List decision policies", "description": { "content": "List the authenticated client's decision policies, paged, with an optional archived filter. A broker client receives each policy's contract only: notes, steps, defaultOutcome, limits, metrics and indicators are omitted from its response.", "type": "text/plain" }, "url": { "path": [ "v1", "decision-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. A value below 1 reads as 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "Items per page. Defaults to 20, and a value above 100 reads as 100.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "Include archived decision policies.", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/v1/decision-policies?page=1" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "87c24ca4-0130-4bd2-ad18-b17b221f1e4e", "name": "Paged decision policies", "originalRequest": { "url": { "path": [ "v1", "decision-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. A value below 1 reads as 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "Items per page. Defaults to 20, and a value above 100 reads as 100.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "Include archived decision policies.", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/v1/decision-policies?page=1" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"items\": [\n {\n \"policyId\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"notes\": \"\",\n \"steps\": [\n {\n \"name\": \"\",\n \"outcome\": \"conditional\",\n \"rules\": [\n {\n \"name\": \"\",\n \"recommendedAction\": \"\",\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n },\n {\n \"name\": \"\",\n \"recommendedAction\": \"\",\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n }\n ]\n },\n {\n \"name\": \"\",\n \"outcome\": \"conditional\",\n \"rules\": [\n {\n \"name\": \"\",\n \"recommendedAction\": \"\",\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n },\n {\n \"name\": \"\",\n \"recommendedAction\": \"\",\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n }\n ]\n }\n ],\n \"declaredInputs\": [\n {\n \"name\": \"\",\n \"kind\": 0\n },\n {\n \"name\": \"\",\n \"kind\": 0\n }\n ],\n \"defaultOutcome\": \"blocked\",\n \"isArchived\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"limits\": [\n {\n \"productId\": \"\",\n \"expression\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"cap\": {\n \"value\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"when\": [\n {\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n },\n {\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n }\n ]\n }\n },\n {\n \"productId\": \"\",\n \"expression\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"cap\": {\n \"value\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"when\": [\n {\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n },\n {\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n }\n ]\n }\n }\n ],\n \"products\": [\n {\n \"productId\": \"\",\n \"slug\": \"\",\n \"name\": \"\"\n },\n {\n \"productId\": \"\",\n \"slug\": \"\",\n \"name\": \"\"\n }\n ],\n \"metrics\": [\n {\n \"metricId\": \"\",\n \"name\": \"\"\n },\n {\n \"metricId\": \"\",\n \"name\": \"\"\n }\n ],\n \"indicators\": [\n {\n \"metricId\": \"\",\n \"format\": \"integer\"\n },\n {\n \"metricId\": \"\",\n \"format\": \"percentage\"\n }\n ]\n },\n {\n \"policyId\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"notes\": \"\",\n \"steps\": [\n {\n \"name\": \"\",\n \"outcome\": \"proceed\",\n \"rules\": [\n {\n \"name\": \"\",\n \"recommendedAction\": \"\",\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n },\n {\n \"name\": \"\",\n \"recommendedAction\": \"\",\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n }\n ]\n },\n {\n \"name\": \"\",\n \"outcome\": \"conditional\",\n \"rules\": [\n {\n \"name\": \"\",\n \"recommendedAction\": \"\",\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n },\n {\n \"name\": \"\",\n \"recommendedAction\": \"\",\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n }\n ]\n }\n ],\n \"declaredInputs\": [\n {\n \"name\": \"\",\n \"kind\": 0\n },\n {\n \"name\": \"\",\n \"kind\": 0\n }\n ],\n \"defaultOutcome\": \"conditional\",\n \"isArchived\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\",\n \"limits\": [\n {\n \"productId\": \"\",\n \"expression\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"cap\": {\n \"value\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"when\": [\n {\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n },\n {\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n }\n ]\n }\n },\n {\n \"productId\": \"\",\n \"expression\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"cap\": {\n \"value\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"when\": [\n {\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n },\n {\n \"expressions\": [\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n },\n {\n \"left\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n },\n \"op\": \"\",\n \"right\": {\n \"kind\": \"metric\",\n \"metricId\": \"\"\n }\n }\n ]\n }\n ]\n }\n }\n ],\n \"products\": [\n {\n \"productId\": \"\",\n \"slug\": \"\",\n \"name\": \"\"\n },\n {\n \"productId\": \"\",\n \"slug\": \"\",\n \"name\": \"\"\n }\n ],\n \"metrics\": [\n {\n \"metricId\": \"\",\n \"name\": \"\"\n },\n {\n \"metricId\": \"\",\n \"name\": \"\"\n }\n ],\n \"indicators\": [\n {\n \"metricId\": \"\",\n \"format\": \"percentage\"\n },\n {\n \"metricId\": \"\",\n \"format\": \"decimal\"\n }\n ]\n }\n ],\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalCount\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "a60435ad-0228-408a-92f2-26bbd1967129", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "decision-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. A value below 1 reads as 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "Items per page. Defaults to 20, and a value above 100 reads as 100.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "Include archived decision policies.", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/v1/decision-policies?page=1" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d731461c-10fb-495c-9c35-ccdb4376a046", "name": "Client lacks required scope: decision-policies:read", "originalRequest": { "url": { "path": [ "v1", "decision-policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. A value below 1 reads as 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "Items per page. Defaults to 20, and a value above 100 reads as 100.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "Include archived decision policies.", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/v1/decision-policies?page=1" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "733e5154-b072-4384-a6d1-6d197684311a", "name": "{slug}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ad34307a-d29c-4e0b-a261-4f6811051bc9", "name": "Get decision policy", "request": { "name": "Get decision policy", "description": { "content": "Retrieve a client's decision policy by slug. A broker client receives the policy's contract only: notes, steps, defaultOutcome, limits, metrics and indicators are omitted from its response.", "type": "text/plain" }, "url": { "path": [ "v1", "decision-policies", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "slug" } ], "raw": "{{baseUrl}}/v1/decision-policies/:slug" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "e9140f8d-d1a2-406f-b73e-d5c7704ad638", "name": "Decision policy", "originalRequest": { "url": { "path": [ "v1", "decision-policies", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "slug" } ], "raw": "{{baseUrl}}/v1/decision-policies/:slug" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"policyId\": \"b91c4e27-6d3f-4a85-9e12-7f0a5c8d3b61\",\n \"name\": \"Business line of credit v1\",\n \"slug\": \"business-line-of-credit-v1\",\n \"declaredInputs\": [\n {\n \"name\": \"requested_amount\",\n \"kind\": \"decimal\"\n },\n {\n \"name\": \"requested_amount\",\n \"kind\": \"decimal\"\n }\n ],\n \"isArchived\": false,\n \"dateCreated\": \"2026-09-18T02:14:37.512Z\",\n \"dateUpdated\": \"2026-09-22T05:41:09.087Z\",\n \"products\": [\n {\n \"productId\": \"3f8d2a6c-91e4-4b7a-8d05-c6e3b1f92a47\",\n \"slug\": \"business-line-of-credit\",\n \"name\": \"Business line of credit\"\n },\n {\n \"productId\": \"3f8d2a6c-91e4-4b7a-8d05-c6e3b1f92a47\",\n \"slug\": \"business-line-of-credit\",\n \"name\": \"Business line of credit\"\n }\n ],\n \"notes\": \"Three times average monthly net inflow, blocked on recent dishonours.\",\n \"steps\": [\n {\n \"name\": \"Dishonour check\",\n \"outcome\": \"conditional\",\n \"rules\": [\n {\n \"name\": \"Dishonours in last 90 days\",\n \"expressions\": [\n {\n \"left\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n },\n \"op\": \">=\",\n \"right\": {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"kind\": \"metric\"\n }\n },\n {\n \"left\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n },\n \"op\": \">=\",\n \"right\": {\n \"name\": \"vedaScore\",\n \"kind\": \"attribute\"\n }\n }\n ],\n \"recommendedAction\": \"Request the last three months of bank statements\"\n },\n {\n \"name\": \"Dishonours in last 90 days\",\n \"expressions\": [\n {\n \"left\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": true,\n \"kind\": \"boolean\"\n },\n \"kind\": \"constant\"\n }\n },\n {\n \"left\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n },\n \"op\": \">=\",\n \"right\": {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"kind\": \"metric\"\n }\n }\n ],\n \"recommendedAction\": \"Request the last three months of bank statements\"\n }\n ]\n },\n {\n \"name\": \"Dishonour check\",\n \"outcome\": \"conditional\",\n \"rules\": [\n {\n \"name\": \"Dishonours in last 90 days\",\n \"expressions\": [\n {\n \"left\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n },\n \"op\": \">=\",\n \"right\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n }\n },\n {\n \"left\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": true,\n \"kind\": \"boolean\"\n },\n \"kind\": \"constant\"\n }\n }\n ],\n \"recommendedAction\": \"Request the last three months of bank statements\"\n },\n {\n \"name\": \"Dishonours in last 90 days\",\n \"expressions\": [\n {\n \"left\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n },\n \"op\": \">=\",\n \"right\": {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"kind\": \"metric\"\n }\n },\n {\n \"left\": {\n \"name\": \"vedaScore\",\n \"kind\": \"attribute\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n }\n }\n ],\n \"recommendedAction\": \"Request the last three months of bank statements\"\n }\n ]\n }\n ],\n \"defaultOutcome\": \"proceed\",\n \"limits\": [\n {\n \"productId\": \"3f8d2a6c-91e4-4b7a-8d05-c6e3b1f92a47\",\n \"expression\": {\n \"op\": \"multiply\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n },\n \"kind\": \"operation\"\n },\n \"caps\": [\n {\n \"value\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n },\n \"when\": [\n {\n \"expressions\": [\n {\n \"left\": {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"kind\": \"metric\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": true,\n \"kind\": \"boolean\"\n },\n \"kind\": \"constant\"\n }\n },\n {\n \"left\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n },\n \"op\": \">=\",\n \"right\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n }\n }\n ]\n },\n {\n \"expressions\": [\n {\n \"left\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n },\n \"op\": \">=\",\n \"right\": {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"kind\": \"metric\"\n }\n },\n {\n \"left\": {\n \"value\": {\n \"value\": true,\n \"kind\": \"boolean\"\n },\n \"kind\": \"constant\"\n },\n \"op\": \">=\",\n \"right\": {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"kind\": \"metric\"\n }\n }\n ]\n }\n ]\n },\n {\n \"value\": {\n \"op\": \"multiply\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n },\n \"kind\": \"operation\"\n },\n \"when\": [\n {\n \"expressions\": [\n {\n \"left\": {\n \"name\": \"vedaScore\",\n \"kind\": \"attribute\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n }\n },\n {\n \"left\": {\n \"value\": {\n \"value\": true,\n \"kind\": \"boolean\"\n },\n \"kind\": \"constant\"\n },\n \"op\": \">=\",\n \"right\": {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"kind\": \"metric\"\n }\n }\n ]\n },\n {\n \"expressions\": [\n {\n \"left\": {\n \"name\": \"vedaScore\",\n \"kind\": \"attribute\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n }\n },\n {\n \"left\": {\n \"name\": \"vedaScore\",\n \"kind\": \"attribute\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n }\n }\n ]\n }\n ]\n }\n ]\n },\n {\n \"productId\": \"3f8d2a6c-91e4-4b7a-8d05-c6e3b1f92a47\",\n \"expression\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n },\n \"caps\": [\n {\n \"value\": {\n \"op\": \"multiply\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n },\n \"kind\": \"operation\"\n },\n \"when\": [\n {\n \"expressions\": [\n {\n \"left\": {\n \"value\": {\n \"value\": true,\n \"kind\": \"boolean\"\n },\n \"kind\": \"constant\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n }\n },\n {\n \"left\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n },\n \"op\": \">=\",\n \"right\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n }\n }\n ]\n },\n {\n \"expressions\": [\n {\n \"left\": {\n \"value\": {\n \"value\": true,\n \"kind\": \"boolean\"\n },\n \"kind\": \"constant\"\n },\n \"op\": \">=\",\n \"right\": {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"kind\": \"metric\"\n }\n },\n {\n \"left\": {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"kind\": \"metric\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": true,\n \"kind\": \"boolean\"\n },\n \"kind\": \"constant\"\n }\n }\n ]\n }\n ]\n },\n {\n \"value\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n },\n \"when\": [\n {\n \"expressions\": [\n {\n \"left\": {\n \"name\": \"vedaScore\",\n \"kind\": \"attribute\"\n },\n \"op\": \">=\",\n \"right\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n }\n },\n {\n \"left\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n },\n \"op\": \">=\",\n \"right\": {\n \"name\": \"vedaScore\",\n \"kind\": \"attribute\"\n }\n }\n ]\n },\n {\n \"expressions\": [\n {\n \"left\": {\n \"name\": \"requested_amount\",\n \"kind\": \"input\"\n },\n \"op\": \">=\",\n \"right\": {\n \"name\": \"vedaScore\",\n \"kind\": \"attribute\"\n }\n },\n {\n \"left\": {\n \"name\": \"vedaScore\",\n \"kind\": \"attribute\"\n },\n \"op\": \">=\",\n \"right\": {\n \"value\": {\n \"value\": 600,\n \"kind\": \"decimal\"\n },\n \"kind\": \"constant\"\n }\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"metrics\": [\n {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"name\": \"Dishonours last 90 days\"\n },\n {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"name\": \"Dishonours last 90 days\"\n }\n ],\n \"indicators\": [\n {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"format\": \"currency\"\n },\n {\n \"metricId\": \"7c2e9f41-3b8a-4d6e-a15f-92d04b7e6c13\",\n \"format\": \"currency\"\n }\n ]\n },\n \"message\": null,\n \"errors\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "644d7fde-0143-48f5-b499-b8a6ac4a500e", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "decision-policies", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "slug" } ], "raw": "{{baseUrl}}/v1/decision-policies/:slug" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "5469bb59-2d39-4831-94f9-6228bc057e3f", "name": "Client lacks required scope: decision-policies:read", "originalRequest": { "url": { "path": [ "v1", "decision-policies", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "slug" } ], "raw": "{{baseUrl}}/v1/decision-policies/:slug" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "3f1d8455-b4ab-4883-956a-2fd50ceaf116", "name": "Decision policy not found", "originalRequest": { "url": { "path": [ "v1", "decision-policies", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The decision policy's slug.", "type": "text/plain" }, "type": "any", "value": "string", "key": "slug" } ], "raw": "{{baseUrl}}/v1/decision-policies/:slug" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] }, { "id": "87e1100f-87b0-43ee-b8c2-afb7c88940ad", "name": "jobs", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f4f270b0-3e74-42c0-bcfe-08d18e32e388", "name": "Get jobs list", "request": { "name": "Get jobs list", "description": { "content": "Retrieve the list of all jobs", "type": "text/plain" }, "url": { "path": [ "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/jobs?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "df4b48fe-e39f-424a-82ac-152569b1bc6a", "name": "Job status with processing progress and transaction counts", "originalRequest": { "url": { "path": [ "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/jobs?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"jobs\": [\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"flow\": \"\",\n \"totalReceivedTransactions\": \"\",\n \"totalProcessedTransactions\": \"\",\n \"totalDuplicateTransactions\": \"\",\n \"totalBatches\": \"\",\n \"completedBatches\": \"\",\n \"warnings\": {\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rowDiscrepancies\": [\n \"\",\n \"\"\n ],\n \"missingAccountDetails\": [\n \"\",\n \"\"\n ],\n \"other\": [\n \"\",\n \"\"\n ],\n \"balanceChainMismatch\": {\n \"pdf\": \"\",\n \"computed\": \"\",\n \"delta\": \"\"\n },\n \"hasAny\": \"\"\n },\n \"tasks\": [\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n }\n ],\n \"fileWarnings\": [\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n },\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedDocuments\": [\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n },\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n }\n ]\n },\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"flow\": \"\",\n \"totalReceivedTransactions\": \"\",\n \"totalProcessedTransactions\": \"\",\n \"totalDuplicateTransactions\": \"\",\n \"totalBatches\": \"\",\n \"completedBatches\": \"\",\n \"warnings\": {\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rowDiscrepancies\": [\n \"\",\n \"\"\n ],\n \"missingAccountDetails\": [\n \"\",\n \"\"\n ],\n \"other\": [\n \"\",\n \"\"\n ],\n \"balanceChainMismatch\": {\n \"pdf\": \"\",\n \"computed\": \"\",\n \"delta\": \"\"\n },\n \"hasAny\": \"\"\n },\n \"tasks\": [\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n }\n ],\n \"fileWarnings\": [\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n },\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedDocuments\": [\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n },\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n }\n ]\n }\n ],\n \"totalCount\": \"\",\n \"currentPage\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "374513c6-ffd2-4556-aa3c-24c789f418a4", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/jobs?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "2e1e0375-f2da-4552-9c64-2c7c9117cfd0", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/jobs?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d0fa992f-4cbd-4f62-b003-430854993736", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "jobs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/jobs?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33bd1234-854b-402c-807f-bbf3ae3e51f0", "name": "{jobId}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1732bf9c-942b-45b0-8cba-e3b73236b8f9", "name": "status", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b2688964-f150-4826-9363-16740568ca10", "name": "Get job processing status", "request": { "name": "Get job processing status", "description": { "content": "Retrieve the current status and progress of a transaction enrichment job.", "type": "text/plain" }, "url": { "path": [ "v1", "jobs", ":jobId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The job id that the transaction submission returned.", "type": "text/plain" }, "type": "any", "value": "{{jobId}}", "key": "jobId" } ], "raw": "{{baseUrl}}/v1/jobs/:jobId/status" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "6a28173e-561b-42b3-aac0-5ee108c4faf1", "name": "Job status with processing progress and transaction counts", "originalRequest": { "url": { "path": [ "v1", "jobs", ":jobId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The job id that the transaction submission returned.", "type": "text/plain" }, "type": "any", "value": "{{jobId}}", "key": "jobId" } ], "raw": "{{baseUrl}}/v1/jobs/:jobId/status" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"flow\": \"\",\n \"jobId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"totalReceivedTransactions\": \"\",\n \"totalProcessedTransactions\": \"\",\n \"totalDuplicateTransactions\": \"\",\n \"totalBatches\": \"\",\n \"completedBatches\": \"\",\n \"warnings\": {\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rowDiscrepancies\": [\n \"\",\n \"\"\n ],\n \"other\": [\n \"\",\n \"\"\n ],\n \"balanceChainMismatch\": {\n \"pdf\": \"\",\n \"computed\": \"\",\n \"delta\": \"\"\n }\n },\n \"tasks\": [\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n }\n ],\n \"fileWarnings\": [\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n },\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedDocuments\": [\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n },\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "7849795c-4019-4332-b8cc-11bfa317f8a2", "name": "Job not found with the specified ID", "originalRequest": { "url": { "path": [ "v1", "jobs", ":jobId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The job id that the transaction submission returned.", "type": "text/plain" }, "type": "any", "value": "{{jobId}}", "key": "jobId" } ], "raw": "{{baseUrl}}/v1/jobs/:jobId/status" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"flow\": \"\",\n \"jobId\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"type\": \"\",\n \"totalReceivedTransactions\": \"\",\n \"totalProcessedTransactions\": \"\",\n \"totalDuplicateTransactions\": \"\",\n \"totalBatches\": \"\",\n \"completedBatches\": \"\",\n \"warnings\": {\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"rowDiscrepancies\": [\n \"\",\n \"\"\n ],\n \"other\": [\n \"\",\n \"\"\n ],\n \"balanceChainMismatch\": {\n \"pdf\": \"\",\n \"computed\": \"\",\n \"delta\": \"\"\n }\n },\n \"tasks\": [\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n {\n \"taskId\": \"\",\n \"taskType\": \"\",\n \"status\": \"\",\n \"fileName\": \"\",\n \"message\": \"\",\n \"extractedCount\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n }\n ],\n \"fileWarnings\": [\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n },\n {\n \"fileName\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"failedDocuments\": [\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n },\n {\n \"taskId\": \"\",\n \"fileName\": \"\",\n \"error\": \"\"\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "32679e1c-364f-4e29-b013-e1e23fb79111", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "jobs", ":jobId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The job id that the transaction submission returned.", "type": "text/plain" }, "type": "any", "value": "{{jobId}}", "key": "jobId" } ], "raw": "{{baseUrl}}/v1/jobs/:jobId/status" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "8c1a06f2-b393-4c10-9df0-539bef417dfc", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "jobs", ":jobId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The job id that the transaction submission returned.", "type": "text/plain" }, "type": "any", "value": "{{jobId}}", "key": "jobId" } ], "raw": "{{baseUrl}}/v1/jobs/:jobId/status" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] } ], "event": [] }, { "id": "57bfbd85-3243-4653-913b-0f790fa0f77c", "name": "metrics", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5e917add-9d9e-485e-818d-c75d3c34026a", "name": "List metrics", "request": { "name": "List metrics", "description": { "content": "List the authenticated client's metrics, paged, with an optional archived filter.", "type": "text/plain" }, "url": { "path": [ "v1", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. A value below 1 reads as 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "Items per page. Defaults to 20, and a value above 100 reads as 100.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "Include archived metrics.", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/v1/metrics?page=1" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "a26f8fb9-d506-4e88-a91d-3e2ea8bc6f23", "name": "Paged metrics", "originalRequest": { "url": { "path": [ "v1", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. A value below 1 reads as 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "Items per page. Defaults to 20, and a value above 100 reads as 100.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "Include archived metrics.", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/v1/metrics?page=1" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"items\": [\n {\n \"metricId\": \"\",\n \"name\": \"\",\n \"templateId\": \"\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"isActive\": \"\",\n \"isArchived\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n {\n \"metricId\": \"\",\n \"name\": \"\",\n \"templateId\": \"\",\n \"parameters\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"isActive\": \"\",\n \"isArchived\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n }\n ],\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalCount\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "62eb10d1-6a08-47e9-afb1-bff4f9f7691d", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. A value below 1 reads as 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "Items per page. Defaults to 20, and a value above 100 reads as 100.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "Include archived metrics.", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/v1/metrics?page=1" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "21a50ea4-4d0c-45c4-a513-39a95ecce853", "name": "Client lacks required scope: metrics:read", "originalRequest": { "url": { "path": [ "v1", "metrics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. A value below 1 reads as 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": true, "description": { "content": "Items per page. Defaults to 20, and a value above 100 reads as 100.", "type": "text/plain" }, "key": "pageSize", "value": "" }, { "disabled": true, "description": { "content": "Include archived metrics.", "type": "text/plain" }, "key": "includeArchived", "value": "" } ], "variable": [], "raw": "{{baseUrl}}/v1/metrics?page=1" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eb3be445-53eb-4b7e-ab0e-863a12a5cdea", "name": "{metricId}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c4b331c3-2151-40c5-9389-a333579b2673", "name": "Get metric", "request": { "name": "Get metric", "description": { "content": "Retrieve a metric by ID.", "type": "text/plain" }, "url": { "path": [ "v1", "metrics", ":metricId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The metric the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "metricId" } ], "raw": "{{baseUrl}}/v1/metrics/:metricId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "c1ad0a2f-a41c-41df-9087-e51ae0014a4f", "name": "Metric", "originalRequest": { "url": { "path": [ "v1", "metrics", ":metricId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The metric the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "metricId" } ], "raw": "{{baseUrl}}/v1/metrics/:metricId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"metricId\": \"\",\n \"name\": \"\",\n \"type\": \"System\",\n \"templateId\": \"\",\n \"parameters\": {\n \"window_days\": 90\n },\n \"isActive\": \"\",\n \"isArchived\": \"\",\n \"dateCreated\": \"\",\n \"dateUpdated\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d1875bd7-bdab-4db8-9491-902efce9b9eb", "name": "Invalid metric ID format", "originalRequest": { "url": { "path": [ "v1", "metrics", ":metricId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The metric the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "metricId" } ], "raw": "{{baseUrl}}/v1/metrics/:metricId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "1620674a-91bc-40cc-9f4d-85a6e60435f9", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "metrics", ":metricId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The metric the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "metricId" } ], "raw": "{{baseUrl}}/v1/metrics/:metricId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "61aa20c4-18d2-4574-b6c2-0f4c26e0ea04", "name": "Client lacks required scope: metrics:read", "originalRequest": { "url": { "path": [ "v1", "metrics", ":metricId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The metric the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "metricId" } ], "raw": "{{baseUrl}}/v1/metrics/:metricId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "98562848-6f3b-4dc8-bb6d-0d73580f361b", "name": "Metric not found", "originalRequest": { "url": { "path": [ "v1", "metrics", ":metricId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The metric the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "metricId" } ], "raw": "{{baseUrl}}/v1/metrics/:metricId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] }, { "id": "1274d96a-817c-4f5c-bdac-dacbe36e8e87", "name": "metric-catalogue", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8bad0229-3d59-4630-8e27-0a81c30b8479", "name": "Get metric catalogue", "request": { "name": "Get metric catalogue", "description": { "content": "List the metric templates a metric may be defined against, with the parameters each template accepts, tagged with the catalogue version the templates belong to.", "type": "text/plain" }, "url": { "path": [ "v1", "metric-catalogue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/metric-catalogue" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "e4a60345-4dea-47c2-8582-31354dd33303", "name": "The metric template catalogue", "originalRequest": { "url": { "path": [ "v1", "metric-catalogue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/metric-catalogue" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"catalogVersion\": \"\",\n \"templates\": [\n {\n \"templateId\": \"\",\n \"name\": \"\",\n \"parameters\": [\n {\n \"name\": \"\",\n \"kind\": \"\",\n \"isList\": \"\",\n \"required\": \"\"\n },\n {\n \"name\": \"\",\n \"kind\": \"\",\n \"isList\": \"\",\n \"required\": \"\"\n }\n ]\n },\n {\n \"templateId\": \"\",\n \"name\": \"\",\n \"parameters\": [\n {\n \"name\": \"\",\n \"kind\": \"\",\n \"isList\": \"\",\n \"required\": \"\"\n },\n {\n \"name\": \"\",\n \"kind\": \"\",\n \"isList\": \"\",\n \"required\": \"\"\n }\n ]\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "87d52504-0d25-4997-93db-b1da2929d969", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "metric-catalogue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/metric-catalogue" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "ce652ab6-fae6-4d24-8d49-cf0bd918cdda", "name": "Client lacks required scope: metrics:read", "originalRequest": { "url": { "path": [ "v1", "metric-catalogue" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/metric-catalogue" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ae79bad8-b777-4404-8faa-de3375cc718a", "name": "rulesets", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "2ee67b8f-f96c-4118-a0ef-d07e36d95394", "name": "evaluations", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "8f3cdb26-2d13-406c-b936-35000c3aedea", "name": "{evaluationResultId}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a2e99bee-37e6-483e-aa17-8b94f76e62aa", "name": "evidence", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4049f3ca-d9ca-4bb2-af30-bf5436d15347", "name": "Get ruleset evaluation evidence", "request": { "name": "Get ruleset evaluation evidence", "description": { "content": "Retrieve the transactions each referenced metric's value was computed from for one recorded ruleset evaluation.", "type": "text/plain" }, "url": { "path": [ "v1", "rulesets", "evaluations", ":evaluationResultId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return evidence for this metric.", "type": "text/plain" }, "key": "metricId", "value": "" }, { "disabled": true, "description": { "content": "Only return one kind of evidence, for example transactions.", "type": "text/plain" }, "key": "kind", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The evaluation result id that the webhook link carries.", "type": "text/plain" }, "type": "any", "value": "", "key": "evaluationResultId" } ], "raw": "{{baseUrl}}/v1/rulesets/evaluations/:evaluationResultId/evidence" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "d43da5f8-55f7-4bfd-be37-38115139f9be", "name": "Evidence for the evaluation", "originalRequest": { "url": { "path": [ "v1", "rulesets", "evaluations", ":evaluationResultId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return evidence for this metric.", "type": "text/plain" }, "key": "metricId", "value": "" }, { "disabled": true, "description": { "content": "Only return one kind of evidence, for example transactions.", "type": "text/plain" }, "key": "kind", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The evaluation result id that the webhook link carries.", "type": "text/plain" }, "type": "any", "value": "", "key": "evaluationResultId" } ], "raw": "{{baseUrl}}/v1/rulesets/evaluations/:evaluationResultId/evidence" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"evaluationResultId\": \"\",\n \"rulesetId\": \"\",\n \"customerId\": \"\",\n \"runAt\": \"\",\n \"metrics\": [\n {\n \"id\": \"\",\n \"evidence\": [\n {\n \"kind\": \"transactions\",\n \"transactionIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"kind\": \"transactions\",\n \"transactionIds\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"id\": \"\",\n \"evidence\": [\n {\n \"kind\": \"transactions\",\n \"transactionIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"kind\": \"transactions\",\n \"transactionIds\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "9a13bc4c-c6d7-4f35-982b-bd9561223021", "name": "Invalid evaluation result ID, metric ID, or evidence kind", "originalRequest": { "url": { "path": [ "v1", "rulesets", "evaluations", ":evaluationResultId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return evidence for this metric.", "type": "text/plain" }, "key": "metricId", "value": "" }, { "disabled": true, "description": { "content": "Only return one kind of evidence, for example transactions.", "type": "text/plain" }, "key": "kind", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The evaluation result id that the webhook link carries.", "type": "text/plain" }, "type": "any", "value": "", "key": "evaluationResultId" } ], "raw": "{{baseUrl}}/v1/rulesets/evaluations/:evaluationResultId/evidence" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "62a6b64f-7571-4602-a7a4-d04a8ffffb02", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "v1", "rulesets", "evaluations", ":evaluationResultId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return evidence for this metric.", "type": "text/plain" }, "key": "metricId", "value": "" }, { "disabled": true, "description": { "content": "Only return one kind of evidence, for example transactions.", "type": "text/plain" }, "key": "kind", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The evaluation result id that the webhook link carries.", "type": "text/plain" }, "type": "any", "value": "", "key": "evaluationResultId" } ], "raw": "{{baseUrl}}/v1/rulesets/evaluations/:evaluationResultId/evidence" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "f680b3f3-bac6-4703-acdc-d4270f21fca6", "name": "Client lacks required scope: rulesets:read", "originalRequest": { "url": { "path": [ "v1", "rulesets", "evaluations", ":evaluationResultId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return evidence for this metric.", "type": "text/plain" }, "key": "metricId", "value": "" }, { "disabled": true, "description": { "content": "Only return one kind of evidence, for example transactions.", "type": "text/plain" }, "key": "kind", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The evaluation result id that the webhook link carries.", "type": "text/plain" }, "type": "any", "value": "", "key": "evaluationResultId" } ], "raw": "{{baseUrl}}/v1/rulesets/evaluations/:evaluationResultId/evidence" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "7617ed82-7ddb-4148-b07c-ae08b2026dc0", "name": "Evaluation result not found", "originalRequest": { "url": { "path": [ "v1", "rulesets", "evaluations", ":evaluationResultId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Only return evidence for this metric.", "type": "text/plain" }, "key": "metricId", "value": "" }, { "disabled": true, "description": { "content": "Only return one kind of evidence, for example transactions.", "type": "text/plain" }, "key": "kind", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "The evaluation result id that the webhook link carries.", "type": "text/plain" }, "type": "any", "value": "", "key": "evaluationResultId" } ], "raw": "{{baseUrl}}/v1/rulesets/evaluations/:evaluationResultId/evidence" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] } ], "event": [] } ], "event": [] }, { "id": "9bea8d40-b396-47eb-9b1d-296906716763", "name": "transactions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "3b64defb-8f31-4531-a38e-62b239b5a11c", "name": "Get all transactions", "request": { "name": "Get all transactions", "description": { "content": "Retrieve all client submitted transactions with optional pagination", "type": "text/plain" }, "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/transactions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "daeefa3f-3c85-47ff-9fdd-5225c7e4b5e5", "name": "All transactions and pagination metadata", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/transactions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"accounts\": [\n {\n \"balance\": {\n \"currentBalance\": \"\",\n \"availableBalance\": \"\",\n \"accountLimit\": \"\"\n },\n \"latestTransactionDate\": \"\",\n \"latestSourcingDate\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"accountName\": \"\",\n \"accountType\": \"\",\n \"accountPurpose\": \"\",\n \"institutionId\": \"\",\n \"institutionName\": \"\",\n \"sourcedVia\": \"\"\n },\n {\n \"balance\": {\n \"currentBalance\": \"\",\n \"availableBalance\": \"\",\n \"accountLimit\": \"\"\n },\n \"latestTransactionDate\": \"\",\n \"latestSourcingDate\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"accountName\": \"\",\n \"accountType\": \"\",\n \"accountPurpose\": \"\",\n \"institutionId\": \"\",\n \"institutionName\": \"\",\n \"sourcedVia\": \"\"\n }\n ],\n \"transactions\": [\n {\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\",\n \"state\": 0,\n \"enrichment\": {\n \"classificationVersion\": \"\",\n \"level1\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level2\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level3\": {\n \"counterpartyId\": \"\",\n \"counterpartyABN\": \"\",\n \"counterpartyName\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n }\n },\n \"enrichmentSource\": \"\",\n \"transactionId\": \"\",\n \"customerId\": \"\",\n \"clientId\": \"\",\n \"suppliedId\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"jobId\": \"\",\n \"jobs\": [\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n },\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n }\n ],\n \"jobIds\": \"\",\n \"sourceType\": \"\"\n },\n {\n \"transactionDate\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"balance\": \"\",\n \"state\": 0,\n \"enrichment\": {\n \"classificationVersion\": \"\",\n \"level1\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level2\": {\n \"value\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n },\n \"level3\": {\n \"counterpartyId\": \"\",\n \"counterpartyABN\": \"\",\n \"counterpartyName\": \"\",\n \"classificationModelId\": \"\",\n \"confidence\": \"\"\n }\n },\n \"enrichmentSource\": \"\",\n \"transactionId\": \"\",\n \"customerId\": \"\",\n \"clientId\": \"\",\n \"suppliedId\": \"\",\n \"accountId\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"jobId\": \"\",\n \"jobs\": [\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n },\n {\n \"jobId\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"dateCreated\": \"\"\n }\n ],\n \"jobIds\": \"\",\n \"sourceType\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"currentPage\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "6431aa14-b66a-4e40-996a-7ea12f19be16", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/transactions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "3906ad3c-b54a-4dfa-80ea-e97bc94571c1", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/transactions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "b921ecc2-5def-43db-bd9e-02d8c6aee281", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/transactions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d1614868-d98d-4dfa-b49b-a2664d08dbd7", "name": "webhooks", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "71292aad-b40b-4158-8dea-5efa49358a8f", "name": "subscriptions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c486379c-7482-46ef-8ff5-9594de2e5326", "name": "Create a webhook subscription", "request": { "name": "Create a webhook subscription", "description": { "content": "Register a webhook subscription to receive event-driven notifications for a specific event type.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"job.completed\",\n \"webhookUrl\": \"https://example.com/hooks/cypher\",\n \"customerIds\": [\n \"{{customerId}}\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "4883a18b-df46-4ff7-8797-fa7fbe02d204", "name": "Webhook subscription created successfully", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"webhookSubscriptionId\": \"\",\n \"clientId\": \"\",\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"dateCreated\": \"\",\n \"secret\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"isCatchAll\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "b5528dd2-bd38-43f2-a75e-43fcf35e7e0f", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "05254338-c8b1-4cfb-b306-ba6812e04bc2", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "128d3210-81f9-4f92-bb3e-20a73918a2a0", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41446d0f-bd05-427a-aa1e-6723093e2b03", "name": "List client's webhook subscriptions", "request": { "name": "List client's webhook subscriptions", "description": { "content": "Retrieve a paginated list of webhook subscriptions for the current client.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "7cdefa46-910a-4913-b044-8c4eb9c3305f", "name": "Webhook subscriptions retrieved successfully", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"subscriptions\": [\n {\n \"webhookSubscriptionId\": \"\",\n \"clientId\": \"\",\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"dateCreated\": \"\",\n \"secret\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"isCatchAll\": \"\"\n },\n {\n \"webhookSubscriptionId\": \"\",\n \"clientId\": \"\",\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"dateCreated\": \"\",\n \"secret\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"isCatchAll\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"currentPage\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d5aa8c7c-fcb4-4bf7-9932-08dce4b22031", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "c8e0f40b-82cc-49a0-9487-417d210a2047", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "fb820214-275b-4a85-89eb-1d8762ed4519", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "1-based page number. Omit it to return every item.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Items per page when page is set. Defaults to 20.", "type": "text/plain" }, "key": "count", "value": "50" } ], "variable": [], "raw": "{{baseUrl}}/v1/webhooks/subscriptions?page=1&count=50" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f352230-ace7-4833-8823-7787b31b6ef0", "name": "{subscriptionId}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "266f3ad2-24c9-4656-bc83-0934ca7a1992", "name": "secret", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "85fa7303-1e4f-4ec2-a468-36cc0d8e2624", "name": "rotate", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "3d0b6d3e-44c7-4c82-8f8d-11218d8f14d9", "name": "Rotate a webhook subscription secret", "request": { "name": "Rotate a webhook subscription secret", "description": { "content": "Generate a new signing secret for an existing webhook subscription. The old secret is immediately invalidated.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "secret", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/secret/rotate" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "49c8b99a-1d1c-4940-80f2-3e7fc0b38515", "name": "Secret rotated successfully", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "secret", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/secret/rotate" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"webhookSubscriptionId\": \"\",\n \"clientId\": \"\",\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"dateCreated\": \"\",\n \"secret\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"isCatchAll\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "678bc4f0-3ab6-422a-b770-c652ecdc25df", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "secret", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/secret/rotate" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "ae0f77ef-707b-466c-ade6-f37e10401add", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "secret", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/secret/rotate" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] }, { "id": "e23f17b3-8faf-441d-9237-d764cd4231a8", "name": "Delete a webhook subscription", "request": { "name": "Delete a webhook subscription", "description": { "content": "Retire a webhook subscription so it stops receiving events. Its delivery history is retained.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "DELETE", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "3e9686e0-eec5-4ca7-806f-f0bb37792a94", "name": "Webhook subscription deleted successfully", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"subscriptionId\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d821fd97-322a-4647-ad6c-d72f5794166a", "name": "Subscription not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "9efe8cd4-62f0-44c4-abea-0769fdf2b15f", "name": "Bad Request", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "083597cd-b857-4cbc-8d53-256854e7d1c4", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "79ddfe28-42f3-4444-bd57-5c2bcf968d8c", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "328fd6da-d44a-47d4-87b7-f53a39714107", "name": "customers", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "c7b81dae-0dde-4be4-99fa-d12bcc9d01b5", "name": "Subscribe customers to a webhook", "request": { "name": "Subscribe customers to a webhook", "description": { "content": "Add customer subscriptions to an existing webhook subscription, scoping it to specific customers.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"{{customerId}}\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "9ae437fe-a8b4-44b6-afe9-5bf78b1def2b", "name": "Customers subscribed successfully", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"webhookSubscriptionId\": \"\",\n \"clientId\": \"\",\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"dateCreated\": \"\",\n \"secret\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"isCatchAll\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d42fa74a-e52b-4afa-90e3-78b5b3ad37c0", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "c1f3ac16-5f72-48bc-a3d4-8812ee7f2f2f", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "a5453ffe-256b-42a2-bb1e-e26dac6c89ef", "name": "Subscription not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "1e8ee875-2085-47e0-9f02-fad2e6ad33c5", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e7a81a9-7e7c-445b-b86a-e582a44ead1d", "name": "Unsubscribe customers from a webhook", "request": { "name": "Unsubscribe customers from a webhook", "description": { "content": "Remove customers from an existing webhook subscription. Legacy subscriptions revert to catch-all when all customers are removed; an explicit catchAll:false subscription remains staged.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"{{customerId}}\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": {}, "id": "91bacfd1-8f4f-4448-874d-af223b38aa53", "name": "Customers unsubscribed successfully", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"webhookSubscriptionId\": \"\",\n \"clientId\": \"\",\n \"eventType\": \"\",\n \"webhookUrl\": \"\",\n \"dateCreated\": \"\",\n \"secret\": \"\",\n \"customerIds\": [\n \"\",\n \"\"\n ],\n \"isCatchAll\": \"\"\n },\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "19682b82-636b-4577-8700-a3fcc3e64795", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "a688f432-16ac-409e-8aec-30b23b02b951", "name": "Insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "d513ff9d-1ec4-4aa8-a094-509d5d4ccca2", "name": "Subscription not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {},\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "_": {}, "id": "b4f6d59f-26c6-4f78-830b-529ab560358f", "name": "Missing or invalid API key or session", "originalRequest": { "url": { "path": [ "v1", "webhooks", "subscriptions", ":subscriptionId", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The webhook subscription the request acts on.", "type": "text/plain" }, "type": "any", "value": "", "key": "subscriptionId" } ], "raw": "{{baseUrl}}/v1/webhooks/subscriptions/:subscriptionId/customers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] } ], "event": [] } ], "event": [] }, { "id": "b9f5becd-d8c9-463f-ab4b-259d6a147c14", "name": "abn", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4681b575-8fad-4bfd-b74c-662a6b678938", "name": "{abn}", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5b2d399f-5efa-4804-86a6-89ca14991544", "name": "Look up an ABN", "request": { "name": "Look up an ABN", "description": { "content": "Returns the ABN's current entry on the Australian Business Register: the entity name, business names, status, entity type, location and GST registration. Nothing is stored.", "type": "text/plain" }, "url": { "path": [ "v1", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The Australian Business Number: 11 digits with a valid checksum.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "key": "x-api-key", "value": "{{apiKey}}", "type": "text" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] } }, "response": [ { "_": { "postman_previewlanguage": "json" }, "id": "f08af0b7-bfc5-472d-b9c0-642aaa7afa5c", "name": "The ABN's register entry", "originalRequest": { "url": { "path": [ "v1", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The Australian Business Number: 11 digits with a valid checksum.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"abn\": \"string\",\n \"entityName\": \"string\",\n \"businessNames\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"string\",\n \"statusEffectiveFrom\": \"1954-11-28\",\n \"entityTypeCode\": \"string\",\n \"entityType\": \"string\",\n \"state\": \"string\",\n \"postcode\": \"string\",\n \"gstRegisteredFrom\": \"2011-02-25\"\n },\n \"message\": null,\n \"errors\": null\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "fd802da4-b9a3-48b4-bf2d-56402a39b1bd", "name": "The ABN is not 11 digits with a valid checksum", "originalRequest": { "url": { "path": [ "v1", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The Australian Business Number: 11 digits with a valid checksum.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "b2f4a178-725b-4f6f-af0d-b6893c6b4da6", "name": "Missing or invalid credentials", "originalRequest": { "url": { "path": [ "v1", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The Australian Business Number: 11 digits with a valid checksum.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "9e3ab3b9-ccf2-47ef-a2ff-c770a2c080be", "name": "The caller's user type, scope or client binding does not permit this operation", "originalRequest": { "url": { "path": [ "v1", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The Australian Business Number: 11 digits with a valid checksum.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "3167b68e-94b6-48c6-b57e-5b2ce3205ed0", "name": "The ABN is not on the register", "originalRequest": { "url": { "path": [ "v1", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The Australian Business Number: 11 digits with a valid checksum.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "d98fedce-f8d7-49bc-a212-868f1b255be4", "name": "Too many requests", "originalRequest": { "url": { "path": [ "v1", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The Australian Business Number: 11 digits with a valid checksum.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] }, { "_": { "postman_previewlanguage": "json" }, "id": "f419f22c-32b1-448b-a093-dc0e37114bcd", "name": "The register is unavailable", "originalRequest": { "url": { "path": [ "v1", "abn", ":abn" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "The Australian Business Number: 11 digits with a valid checksum.", "type": "text/plain" }, "type": "any", "value": "string", "key": "abn" } ], "raw": "{{baseUrl}}/v1/abn/:abn" }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": null,\n \"message\": \"One or more validation errors occurred\",\n \"errors\": [\n {\n \"code\": \"NotEmptyValidator\",\n \"description\": \"'Abn' must not be empty.\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [] } ], "event": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// auto-generated by postman-add-features: environment selection", "const environment = (pm.collectionVariables.get('environment') || '').trim().toLowerCase();", "const known = [\"sandbox\",\"production\"];", "if (!known.includes(environment)) {", " throw new Error(`Set the collection variable \"environment\" to one of: ${known.join(', ')}.`);", "}", "pm.variables.set('baseUrl', pm.collectionVariables.get(`${environment}BaseUrl`));", "const apiKey = pm.collectionVariables.get(`${environment}ApiKey`);", "if (apiKey) {", " pm.variables.set('apiKey', apiKey);", "}" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://sandbox.walkerstdata.com.au", "type": "any", "description": "Set before each request from the selected environment." }, { "key": "apiKey", "value": "YOUR_API_KEY_HERE", "type": "string" }, { "key": "jobId", "value": "", "type": "string" }, { "key": "customerId", "value": "", "type": "string" }, { "key": "abn", "value": "", "type": "string" }, { "key": "environment", "value": "sandbox", "type": "string", "description": "Which API to call: sandbox or production." }, { "key": "sandboxBaseUrl", "value": "https://sandbox.walkerstdata.com.au", "type": "string", "description": "Base URL of the Sandbox API." }, { "key": "sandboxApiKey", "value": "", "type": "string", "description": "Your Sandbox API key." }, { "key": "productionBaseUrl", "value": "https://api.walkerstdata.com.au", "type": "string", "description": "Base URL of the Production API." }, { "key": "productionApiKey", "value": "", "type": "string", "description": "Your Production API key." } ], "info": { "_postman_id": "c601bbb8-a22e-4f5e-a5f2-a298b1711581", "name": "Walker Street Data API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Walker Street Data transaction classification and enrichment API.\n\nProvides automated categorization of bank transactions for Australian SME lenders.\nTakes raw transaction data (date, amount, description) and enriches it with\nhierarchical classifications (Level 1/2/3 categories).\n\n## Authentication\nEvery request is authenticated with your client API key, sent in the `x-api-key` header.\nA missing or invalid key returns `401`; a valid key without the scope an endpoint needs returns `403`.\n\n## Pagination\nPaginated endpoints use 1-indexed page numbers (page >= 1).\nDefault page size is 20 results per page.\n\n## Response Format\nAll responses are wrapped in an `ApiResponse` object:\n- On success: `{ \"data\": , \"message\": null }`\n- On error: `{ \"data\": null, \"message\": \"\" }`\n\nContact Support:\n Name: Walker Street Data\n Email: contact@walkerstdata.com.au", "type": "text/plain" } } }