{
  "item": [
    {
      "id": "419a5ff6-b6bc-4ea0-bf0b-807e29b80064",
      "name": "Customer",
      "description": {
        "content": "The Customer the API key belongs to: its name, its standing and the Providers that approved it.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "58bcfa6f-6174-4f8e-a58a-6353a4c98b04",
          "name": "Get the Customer",
          "request": {
            "name": "Get the Customer",
            "description": {
              "content": "The Customer the API key belongs to (or, with `Apex-End-Customer`, that End Customer): its legal name, type and country, its `standing` (`onboarding`, `active`, `suspended` or `closed`), its `kind` (`direct`, `platform`, or `end_customer` of a Platform) and the Providers that approved it. It answers while the Customer is still being onboarded or suspended, so a client can tell why other operations are refused.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "customer"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "4149455d-1ec2-47ad-8799-c57b1a8dc322",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "customer"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"country\": \"US\",\n  \"id\": \"2b7e4f1a-6c3d-4e8b-9a0f-1d2c3b4a5e6f\",\n  \"kind\": \"direct\",\n  \"legal_name\": \"Tom Becker\",\n  \"providers\": [\n    \"bvnk\",\n    \"zerohash\"\n  ],\n  \"standing\": \"active\",\n  \"type\": \"individual\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "dd23c2b9-753a-497a-a198-d18f46c15f2a",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "customer"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e789b792-613e-4f50-b83d-da9aadc0b166",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer was rejected.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "customer"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "fc4aaa2d-3b95-4b5a-9374-5685b647a0b8",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "customer"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "98db9be6-8bae-4a4a-b52f-e322a117101d",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "customer"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "aeb72c6d-82af-4b0c-841f-05987a4b4b42",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "customer"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "4c85b167-62bf-4490-9caf-67d7afbb50cf",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "customer"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "98fdcff1-fc5d-4473-be87-7a5c14f6d1aa",
      "name": "Onboarding",
      "description": {
        "content": "Passing due diligence: the Compliance Profile, its documents and the terms, then submission for review. These are the only operations open while the Customer is being onboarded.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "855818d0-2481-4333-bf9c-2540bad086c4",
          "name": "List Compliance Documents",
          "request": {
            "name": "List Compliance Documents",
            "description": {
              "content": "Every version of every Compliance Document the Customer uploaded, newest first; `current` marks the version in force for its kind and subject.\n\nRequires the `customer:profile:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "documents"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "5acf0ea4-e91f-4412-b1ad-460ea6a5926b",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "[\n  {\n    \"current\": true,\n    \"file_name\": \"government_id.pdf\",\n    \"id\": \"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a\",\n    \"kind\": \"government_id\",\n    \"mime\": \"application/pdf\",\n    \"sha256\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\",\n    \"size_bytes\": 482113,\n    \"subject_kind\": \"individual\",\n    \"uploaded_at\": \"2026-11-10T16:30:00Z\",\n    \"version\": 1,\n    \"subject_ref\": \"string\",\n    \"superseded_at\": \"1984-07-28T02:33:04.260Z\"\n  },\n  {\n    \"current\": true,\n    \"file_name\": \"government_id.pdf\",\n    \"id\": \"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a\",\n    \"kind\": \"government_id\",\n    \"mime\": \"application/pdf\",\n    \"sha256\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\",\n    \"size_bytes\": 482113,\n    \"subject_kind\": \"individual\",\n    \"uploaded_at\": \"2026-11-10T16:30:00Z\",\n    \"version\": 1,\n    \"subject_ref\": \"string\",\n    \"superseded_at\": \"1961-05-21T18:36:54.597Z\"\n  }\n]",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1bf430a4-da7b-4924-a77a-b057887b4d4b",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "68a3adb4-faaf-4f15-b85a-d91d74a8d361",
              "name": "- `forbidden`: The API key does not hold the `customer:profile:write` permission.\n- `customer_not_active`: The Customer was rejected.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "fa3d2c98-e159-4d18-b011-676ae11a5dd0",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b7ab14fb-bf41-44bd-ba72-63ab5b351d6e",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b6617746-7996-4bc8-af80-6877fb0b0c96",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "957b29e6-7767-4af1-8ed1-9c306519e51d",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "a0c492f3-8e81-440f-b61a-4b146445f4a2",
          "name": "Upload a Compliance Document",
          "request": {
            "name": "Upload a Compliance Document",
            "description": {
              "content": "Uploads one file of evidence for the Compliance Profile as `multipart/form-data`: `file`, `kind`, `subject_kind` and, for a beneficial owner or a control person, `subject_ref`, the person's name exactly as the profile spells it. PDF, JPEG or PNG, judged from the bytes, at most 10 MB; a Customer holds at most 200 versions and 200 MB. A new file of the same kind about the same subject becomes the next version and the older one stays. `GET /v1/onboarding` lists the documents a submission still needs. Refused once the profile is submitted, unless Compliance sends it back.\n\nRequires the `customer:profile:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "documents"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Content-Type",
                "value": "multipart/form-data"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "file",
                  "type": "file",
                  "description": "(Required) The file: PDF, JPEG or PNG, at most 10 MB."
                },
                {
                  "key": "kind",
                  "value": "<string>",
                  "type": "text",
                  "description": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)"
                },
                {
                  "key": "subject_kind",
                  "value": "<string>",
                  "type": "text",
                  "description": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)"
                },
                {
                  "key": "subject_ref",
                  "value": "<string>",
                  "type": "text",
                  "description": "For ubo and control_person, the person's name as the profile spells it."
                }
              ]
            }
          },
          "response": [
            {
              "id": "983e86e8-d421-4ea6-9421-f9c2b6182387",
              "name": "Created",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"current\": true,\n  \"file_name\": \"government_id.pdf\",\n  \"id\": \"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a\",\n  \"kind\": \"government_id\",\n  \"mime\": \"application/pdf\",\n  \"sha256\": \"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\",\n  \"size_bytes\": 482113,\n  \"subject_kind\": \"individual\",\n  \"uploaded_at\": \"2026-11-10T16:30:00Z\",\n  \"version\": 1,\n  \"subject_ref\": \"string\",\n  \"superseded_at\": \"1980-01-20T22:35:11.746Z\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "052536fa-2a68-4db1-8dc5-13aef9333fab",
              "name": "- `document_file_required`: The request is not multipart/form-data or has no readable `file` part.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6ae90e27-cc23-4fef-aac8-0f7146710779",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "aa6cbf24-c66c-42ef-9d45-28eeb8872506",
              "name": "- `forbidden`: The API key does not hold the `customer:profile:write` permission.\n- `customer_not_active`: The Customer was rejected.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e46cf870-490f-4abb-8896-bce84e231f8c",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "2b1230dd-b5b9-40d7-b200-8e0f7c2231e0",
              "name": "- `profile_locked`: The profile is submitted; it changes again only if Compliance sends it back.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8f3a4259-18cb-4420-b99f-f267a27776cd",
              "name": "- `payload_too_large`: The request is larger than 12 MB.\n- `document_too_large`: The file is larger than 10 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "766503fa-1e80-4fdb-bdcc-1a9342b35b1e",
              "name": "- `document_empty`: The file is empty.\n- `document_type_not_allowed`: The file is not a PDF, JPEG or PNG.\n- `document_kind_unknown`: `kind` is not a document kind.\n- `document_subject_invalid`: `subject_kind` does not fit the Customer's type or the document's kind, or `subject_ref` is missing for a person or given for the business.\n- `document_limit_reached`: The Customer already holds 200 versions or 200 MB of documents.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f5cf7c6b-ea47-4a87-8a56-cd83c8f62802",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "652f8486-404e-48b8-8e69-1add644c5943",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c73c702b-152e-4157-8290-9288befb00b0",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7e9dbe38-dfab-4d46-b0af-c76d7dfaaad6",
              "name": "- `document_busy`: Too many files are being handled at once; retry shortly.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "formdata",
                  "formdata": [
                    {
                      "description": {
                        "content": "(Required) The file: PDF, JPEG or PNG, at most 10 MB.",
                        "type": "text/plain"
                      },
                      "key": "file",
                      "value": "<binary>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) What the document is. (This can only be one of certificate_of_incorporation,articles_or_by_laws,certificate_of_good_standing,operating_agreement,proof_of_address,ownership_structure,government_id,other)",
                        "type": "text/plain"
                      },
                      "key": "kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "(Required) Whom it is about. (This can only be one of business,ubo,control_person,individual)",
                        "type": "text/plain"
                      },
                      "key": "subject_kind",
                      "value": "<string>",
                      "type": "text"
                    },
                    {
                      "description": {
                        "content": "For ubo and control_person, the person's name as the profile spells it.",
                        "type": "text/plain"
                      },
                      "key": "subject_ref",
                      "value": "<string>",
                      "type": "text"
                    }
                  ]
                }
              },
              "status": "Service Unavailable",
              "code": 503,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "fe801ae7-1778-43c7-971f-be04e0293efb",
          "name": "Download a Compliance Document",
          "request": {
            "name": "Download a Compliance Document",
            "description": {
              "content": "The file itself, as an attachment of its type (`application/pdf`, `image/jpeg` or `image/png`). Every read is recorded.\n\nRequires the `customer:profile:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "documents",
                ":id",
                "content"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The document's id."
                }
              ]
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/pdf"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "ff4fb01e-7922-4509-8868-0ea428f98305",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents",
                    ":id",
                    "content"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The document's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/pdf"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/pdf"
                }
              ],
              "body": "string",
              "cookie": [],
              "_postman_previewlanguage": "text"
            },
            {
              "id": "f7fd1bf1-296f-496a-9a9b-807a4d21435f",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents",
                    ":id",
                    "content"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The document's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "00a457c8-7a25-4227-a599-6aedafed2a9b",
              "name": "- `forbidden`: The API key does not hold the `customer:profile:write` permission.\n- `customer_not_active`: The Customer was rejected.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents",
                    ":id",
                    "content"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The document's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "91d3b3b7-f2c4-4cb9-86aa-c4521082cb4d",
              "name": "- `document_not_found`: No document of this Customer has this id.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents",
                    ":id",
                    "content"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The document's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c3892c48-4c5a-4439-b108-f4d5f6d52076",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents",
                    ":id",
                    "content"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The document's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b3832bde-9211-42d6-96ac-5b970d145929",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents",
                    ":id",
                    "content"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The document's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "730508b5-7827-43e8-8dcb-f621118bc716",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents",
                    ":id",
                    "content"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The document's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "2f5d9f11-2b86-4b1b-871e-a8d860e3aa6d",
              "name": "- `document_busy`: Too many files are being handled at once; retry shortly.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "documents",
                    ":id",
                    "content"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The document's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Service Unavailable",
              "code": 503,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "1a6d1e0f-b2cb-46e0-8b59-028ec9cdd5aa",
          "name": "Get the onboarding status",
          "request": {
            "name": "Get the onboarding status",
            "description": {
              "content": "Where the Customer stands on its way in and what it still owes. `state` is `profile_pending` while the profile is a draft, `profile_review` once it is submitted, `contract_pending` while the platform's terms wait for acceptance, `provider_onboarding` while the Providers decide, then `active`; or `suspended` or `rejected`. With it come the fields Compliance asked to change (`requested_fields`, `note`), the profile fields still missing, every document a submission needs and whether it is uploaded, whether the terms are accepted, and each Provider's decision.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "onboarding"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "2d55b098-a715-4e78-a77c-7ee357b0b923",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "onboarding"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"documents\": [\n    {\n      \"kind\": \"government_id\",\n      \"subject_kind\": \"individual\",\n      \"uploaded\": true\n    },\n    {\n      \"kind\": \"proof_of_address\",\n      \"subject_kind\": \"individual\",\n      \"uploaded\": false\n    }\n  ],\n  \"missing_fields\": [\n    {\n      \"field\": \"individual.date_of_birth\",\n      \"message\": \"required\"\n    },\n    {\n      \"field\": \"individual.date_of_birth\",\n      \"message\": \"required\"\n    }\n  ],\n  \"providers\": [\n    {\n      \"provider\": \"bvnk\",\n      \"state\": \"approved\"\n    },\n    {\n      \"provider\": \"bvnk\",\n      \"state\": \"approved\"\n    }\n  ],\n  \"requested_fields\": [\n    \"individual.address.line1\"\n  ],\n  \"standing\": \"onboarding\",\n  \"state\": \"profile_pending\",\n  \"terms_accepted\": false,\n  \"type\": \"individual\",\n  \"note\": \"Please upload a proof of address dated within three months.\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "abbfa9d3-f191-42bf-8635-cef4f2263bfe",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "onboarding"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "939bd79c-df58-46c1-8125-6f2185de843c",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer was rejected.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "onboarding"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "787a980e-84bf-4b33-8c8e-8c952abda6f2",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "onboarding"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "4ae7c7be-462f-4301-9780-5537ea7445b9",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "onboarding"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d6047781-fd9c-424f-92b1-c322f5d27a30",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "onboarding"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7f1b25de-632f-4916-83f0-c3a0ac38e0c5",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "onboarding"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "c0a836b2-f7d9-4c60-8845-0acce7a3e31f",
          "name": "Get the Compliance Profile",
          "request": {
            "name": "Get the Compliance Profile",
            "description": {
              "content": "The Customer's Compliance Profile: the draft while it is `profile_pending`, else its last submission, with the fields Compliance asked to change.\n\nRequires the `customer:profile:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "profile"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "132ecadf-bdf9-473b-824a-3121d8bb5e51",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"other\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  },\n  \"requested_fields\": [\n    \"individual.address.line1\"\n  ],\n  \"version\": 1,\n  \"request_note\": \"Please upload a proof of address dated within three months.\",\n  \"submitted_at\": \"2026-11-10T16:45:00Z\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c6556951-ddb8-486c-a4c8-e2a94c9e1121",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "df3cf293-7adf-4ba0-bd90-fa533c322ad5",
              "name": "- `forbidden`: The API key does not hold the `customer:profile:write` permission.\n- `customer_not_active`: The Customer was rejected.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "9c263d18-7a9b-4107-a13a-103fd29d0ee3",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "55dbcc90-2e12-4bfc-84f0-9bc16448b691",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "ad5e4fdb-8363-4669-bc83-08ddade7d37c",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "a45e96be-c015-42f0-992e-dca13d18c233",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "183e7474-1749-4d10-bb53-7f83e0747796",
          "name": "Save the Compliance Profile draft",
          "request": {
            "name": "Save the Compliance Profile draft",
            "description": {
              "content": "Replaces the draft with `data`: `business` for a business Customer, `individual` for an individual one. A draft may be incomplete; nothing is judged until it is submitted. Refused once the profile is submitted, unless Compliance sends it back.\n\nRequires the `customer:profile:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "profile"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "PUT",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"<string>\",\n        \"country\": \"<string>\",\n        \"line1\": \"<string>\",\n        \"line2\": \"<string>\",\n        \"postal_code\": \"<string>\",\n        \"region\": \"<string>\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"<string>\",\n          \"name\": \"<string>\",\n          \"role\": \"<string>\"\n        },\n        {\n          \"email\": \"<string>\",\n          \"name\": \"<string>\",\n          \"role\": \"<string>\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"<date>\",\n          \"name\": \"<string>\",\n          \"nationality\": \"<string>\",\n          \"tax_id\": \"<string>\",\n          \"title\": \"<string>\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"<date>\",\n          \"name\": \"<string>\",\n          \"nationality\": \"<string>\",\n          \"tax_id\": \"<string>\",\n          \"title\": \"<string>\"\n        }\n      ],\n      \"corridors\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"date_established\": \"<date>\",\n      \"entity_type\": \"<string>\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"<decimal>\",\n        \"asset\": \"<string>\"\n      },\n      \"legal_name\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"registration_number\": \"<string>\",\n      \"tax_id\": \"<string>\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"<string>\",\n          \"date_of_birth\": \"<date>\",\n          \"name\": \"<string>\",\n          \"nationality\": \"<string>\",\n          \"share_percent\": \"<string>\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"<string>\",\n          \"date_of_birth\": \"<date>\",\n          \"name\": \"<string>\",\n          \"nationality\": \"<string>\",\n          \"share_percent\": \"<string>\"\n        }\n      ],\n      \"website\": \"<string>\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"<string>\",\n        \"country\": \"<string>\",\n        \"line1\": \"<string>\",\n        \"line2\": \"<string>\",\n        \"postal_code\": \"<string>\",\n        \"region\": \"<string>\"\n      },\n      \"date_of_birth\": \"<date>\",\n      \"full_name\": \"<string>\",\n      \"nationality\": \"<string>\"\n    }\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "8196e120-6ce4-40d4-be2e-d52ba8961ee8",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"other\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  },\n  \"requested_fields\": [\n    \"individual.address.line1\"\n  ],\n  \"version\": 1,\n  \"request_note\": \"Please upload a proof of address dated within three months.\",\n  \"submitted_at\": \"2026-11-10T16:45:00Z\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f19e59e4-ff94-486e-8736-a45074da6bbf",
              "name": "- `bad_request`: The body is not valid JSON, or a field has the wrong type.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "570efdf5-b462-49f3-90a8-2df4ae09aa94",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d20dc89b-e32c-48d9-8d60-dfc317a0ff01",
              "name": "- `forbidden`: The API key does not hold the `customer:profile:write` permission.\n- `customer_not_active`: The Customer was rejected.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d93109dc-74bf-4563-8d4f-04f8205e8529",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "3d5aa3fb-452f-4e4b-b50b-6b18dfa0e2ca",
              "name": "- `profile_locked`: The profile is submitted; it changes again only if Compliance sends it back.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "28b5a7b0-e378-485e-bb93-ad73e830a40f",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c4d945f6-9af1-4058-9d94-f1cd3097b77c",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f1fbc438-4db1-49da-8934-f8bcdc455834",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "38cfab00-d46f-4478-8166-37ad2c021e43",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"data\": {\n    \"business\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"authorised_persons\": [\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        },\n        {\n          \"email\": \"tom@example.com\",\n          \"name\": \"Tom Becker\",\n          \"role\": \"Director\"\n        }\n      ],\n      \"control_persons\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"tax_id\": \"string\",\n          \"title\": \"Managing Director\"\n        }\n      ],\n      \"corridors\": [\n        \"US-DE\",\n        \"US-PK\"\n      ],\n      \"date_established\": \"2019-03-01\",\n      \"entity_type\": \"trust\",\n      \"expected_monthly_volume\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"legal_name\": \"Becker Trading LLC\",\n      \"phone\": \"+12125550100\",\n      \"registration_number\": \"7712345\",\n      \"tax_id\": \"string\",\n      \"ubos\": [\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        },\n        {\n          \"address\": {\n            \"city\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"country\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line1\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"line2\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"postal_code\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            },\n            \"region\": {\n              \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n            }\n          },\n          \"country\": \"US\",\n          \"date_of_birth\": \"1985-04-12\",\n          \"name\": \"Tom Becker\",\n          \"nationality\": \"US\",\n          \"share_percent\": \"100\"\n        }\n      ],\n      \"website\": \"https://becker-trading.example.com\"\n    },\n    \"individual\": {\n      \"address\": {\n        \"city\": \"New York\",\n        \"country\": \"US\",\n        \"line1\": \"350 Fifth Avenue\",\n        \"line2\": \"Suite 4100\",\n        \"postal_code\": \"10118\",\n        \"region\": \"NY\"\n      },\n      \"date_of_birth\": \"1985-04-12\",\n      \"full_name\": \"Tom Becker\",\n      \"nationality\": \"US\"\n    }\n  }\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "116e9a25-8e75-40ef-9f17-0fc2264a4edd",
          "name": "Submit the Compliance Profile",
          "request": {
            "name": "Submit the Compliance Profile",
            "description": {
              "content": "Sends the profile to Compliance for review. It must be complete, its address must be in the Customer's country, every document `GET /v1/onboarding` lists must be uploaded and the terms of `GET /v1/terms` accepted. The answer is the onboarding status; Compliance's decision moves it on.\n\nRequires the `customer:profile:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "profile",
                "submit"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST"
          },
          "response": [
            {
              "id": "7d0f30c2-9765-409a-bf4d-71ad5c184652",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile",
                    "submit"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"documents\": [\n    {\n      \"kind\": \"government_id\",\n      \"subject_kind\": \"individual\",\n      \"uploaded\": true\n    },\n    {\n      \"kind\": \"proof_of_address\",\n      \"subject_kind\": \"individual\",\n      \"uploaded\": false\n    }\n  ],\n  \"missing_fields\": [\n    {\n      \"field\": \"individual.date_of_birth\",\n      \"message\": \"required\"\n    },\n    {\n      \"field\": \"individual.date_of_birth\",\n      \"message\": \"required\"\n    }\n  ],\n  \"providers\": [\n    {\n      \"provider\": \"bvnk\",\n      \"state\": \"approved\"\n    },\n    {\n      \"provider\": \"bvnk\",\n      \"state\": \"approved\"\n    }\n  ],\n  \"requested_fields\": [\n    \"individual.address.line1\"\n  ],\n  \"standing\": \"onboarding\",\n  \"state\": \"profile_pending\",\n  \"terms_accepted\": false,\n  \"type\": \"individual\",\n  \"note\": \"Please upload a proof of address dated within three months.\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "18d8a412-c81a-4c78-b4fb-ea9710174bae",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile",
                    "submit"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b2522b98-ad5f-4369-96ec-880d9308c0c1",
              "name": "- `forbidden`: The API key does not hold the `customer:profile:write` permission.\n- `customer_not_active`: The Customer was rejected.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile",
                    "submit"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b171d89d-800b-4270-b50e-701918924026",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile",
                    "submit"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c785c797-26bc-4b31-b5bc-405cdd5aecfa",
              "name": "- `profile_locked`: The profile is already submitted.\n- `terms_not_accepted`: The current terms are not all accepted.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile",
                    "submit"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "5c5fa958-76c2-4504-9a19-c3b1b8b27ebb",
              "name": "- `profile_missing`: No draft was saved yet.\n- `country_mismatch`: The address is not in the country the Customer was opened in.\n- `country_not_accepted`: The address country is not one the platform serves.\n- `profile_invalid`: Fields or documents are missing or malformed, and `details` names each.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile",
                    "submit"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7ebe96fc-188e-43a1-a5f0-0360ee812889",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile",
                    "submit"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6f87240b-b93d-403b-b650-33087f3bf06f",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile",
                    "submit"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "68fa63a4-6553-4182-b953-7717cf4cbb6e",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "profile",
                    "submit"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "3024872e-5c21-4b3c-9701-636b64dfe22d",
          "name": "Get the terms",
          "request": {
            "name": "Get the terms",
            "description": {
              "content": "The terms the Customer must accept, the platform's and each Provider's, each with its version and link, and whether they are all accepted. `version` names the whole set: send it back to `POST /v1/terms`. An End Customer whose set is empty reads `accepted: true` and need not accept anything.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "terms"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "2db8932e-4a0e-4962-aa9e-c3d4b03334dd",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"accepted\": true,\n  \"documents\": [\n    {\n      \"id\": \"platform\",\n      \"version\": \"2026-10-01\",\n      \"accepted_at\": \"2026-11-10T16:40:00Z\",\n      \"provider\": \"bvnk\",\n      \"url\": \"https://example.com/terms/bvnk\"\n    },\n    {\n      \"id\": \"platform\",\n      \"version\": \"2026-10-01\",\n      \"accepted_at\": \"2026-11-10T16:40:00Z\",\n      \"provider\": \"bvnk\",\n      \"url\": \"https://example.com/terms/bvnk\"\n    }\n  ],\n  \"version\": \"string\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "ce4e6679-f3c1-445d-b91e-967e755cf42d",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c2cf56d1-d4ce-4102-a447-51b26070b216",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer was rejected.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b35105b5-40c8-4339-8cfd-7d8bf7c57379",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "13dd31cf-47d4-4754-b2bc-d0bb24a83ca4",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8fc8539a-b6f6-46e3-8b89-221044d5189b",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "5592ec9c-dc18-4633-9162-96f7f64f77cd",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "c092dfdd-d47d-4da1-a53d-5be3802e0e82",
          "name": "Accept the terms",
          "request": {
            "name": "Accept the terms",
            "description": {
              "content": "Accepts, for the Customer, every document of the terms set `GET /v1/terms` answered, named by its `version`. A set that changed since it was read is refused with `terms_changed`: read it again.\n\nRequires the `customer:profile:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "terms"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"version\": \"<string>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "0bf87008-d0b2-41fe-a086-ae0f1893ee1e",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"accepted\": true,\n  \"documents\": [\n    {\n      \"id\": \"platform\",\n      \"version\": \"2026-10-01\",\n      \"accepted_at\": \"2026-11-10T16:40:00Z\",\n      \"provider\": \"bvnk\",\n      \"url\": \"https://example.com/terms/bvnk\"\n    },\n    {\n      \"id\": \"platform\",\n      \"version\": \"2026-10-01\",\n      \"accepted_at\": \"2026-11-10T16:40:00Z\",\n      \"provider\": \"bvnk\",\n      \"url\": \"https://example.com/terms/bvnk\"\n    }\n  ],\n  \"version\": \"string\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1eea6a2d-45f6-46b0-b82f-a201f402a792",
              "name": "- `bad_request`: The body is not valid JSON.\n- `validation_failed`: `version` is missing or longer than 1024 characters.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c9fdcc34-667b-4677-804b-040d62e77dd3",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "139dc9f7-4edf-4f12-93a6-7dc595a2d423",
              "name": "- `forbidden`: The API key does not hold the `customer:profile:write` permission.\n- `customer_not_active`: The Customer was rejected.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "77615ab3-b124-4fe8-b6fe-e9bf9d5498d0",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "2e8ce2e5-b11b-439b-82db-4edf0701ab84",
              "name": "- `profile_locked`: The Customer is past the steps where terms are accepted.\n- `terms_changed`: `version` is not the current set's; read `GET /v1/terms` again.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "4f604145-4807-40af-85c6-e8b6c7d6a6fb",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "5a8b2611-2647-4882-ae9a-fe57ef16cdca",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6b92787c-2625-44c3-8bec-94a32358d78b",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b8442166-be61-426d-9a80-fb089b139724",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "terms"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"version\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "cde3bd41-05c2-4bf6-94ab-1b463c70a14d",
      "name": "Balances",
      "description": {
        "content": "What the Customer holds, per asset and per Provider, available to spend and held for Payouts.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "dc38ada5-1d18-4d23-92f7-abb1bf3022e3",
          "name": "List balances",
          "request": {
            "name": "List balances",
            "description": {
              "content": "The Customer's balance in each asset it holds: `available` to spend and `held` for Payouts that are funded and not finished. `held_at` splits each total by the Provider holding it (`provider` is the key `GET /v1/deposit-instructions` answers). A Payout draws on one Provider's part only, the one its Route starts at, so a Quote can say `funds_at_other_provider` while the total would cover it.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "balances"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "d474abb2-072b-4a28-9386-2153e95142dc",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "balances"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "[\n  {\n    \"asset\": \"USDC\",\n    \"available\": \"1000\",\n    \"held\": \"0\",\n    \"held_at\": [\n      {\n        \"available\": \"1000\",\n        \"held\": \"0\",\n        \"provider\": \"bvnk\"\n      }\n    ]\n  },\n  {\n    \"asset\": \"USDC\",\n    \"available\": \"1000\",\n    \"held\": \"0\",\n    \"held_at\": [\n      {\n        \"available\": \"1000\",\n        \"held\": \"0\",\n        \"provider\": \"bvnk\"\n      }\n    ]\n  }\n]",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "fa539f1c-a4d2-4c50-9e17-ed061895d0fc",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "balances"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "10cc645f-4255-47f0-88b3-29f52e290575",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "balances"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1f595a82-ac9f-4497-b5da-00759fddbd2c",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "balances"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "82621492-0ebb-40a2-82a3-9287099268ac",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "balances"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7e631aa3-cddd-40c8-9597-0baea69c6d04",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "balances"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "ba38d1e6-a562-4b9f-8f2d-1157538976b2",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "balances"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "d9b87f02-58f6-48ab-afac-4e3e2d54e098",
      "name": "Deposits",
      "description": {
        "content": "Where the Customer sends funds to credit its balance. A credited Deposit is announced by the `deposit.received` webhook.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "2d2111ae-68e6-4ce5-8cc1-1114247d94a6",
          "name": "List deposit instructions",
          "request": {
            "name": "List deposit instructions",
            "description": {
              "content": "Where to send an asset to credit the Customer's balance: one entry per Provider that approved the Customer and takes Deposits of the asset, with a wallet `address` and `network` (and a `memo` where the network needs one) for a stablecoin, or `bank_details` for a bank transfer. A Deposit counts once its source is verified, and the `deposit.received` webhook announces it. A Deposit is held at the Provider it was sent to, and only Routes that start there spend it (see `GET /v1/balances`). An empty list means no Provider that approved the Customer takes the asset; a Provider that cannot answer for a moment is left out.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "deposit-instructions"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [
                {
                  "disabled": false,
                  "key": "asset",
                  "value": "<string>",
                  "description": "(Required) The asset to deposit, such as USDC."
                }
              ],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "32b9675b-af4e-43d6-b23d-07dba8bcfb10",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "deposit-instructions"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "asset",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "[\n  {\n    \"asset\": \"USDC\",\n    \"provider\": \"bvnk\",\n    \"address\": \"0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed\",\n    \"bank_details\": {\n      \"key_0\": \"string\",\n      \"key_1\": \"string\"\n    },\n    \"memo\": \"\",\n    \"network\": \"ETH\"\n  },\n  {\n    \"asset\": \"USDC\",\n    \"provider\": \"bvnk\",\n    \"address\": \"0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed\",\n    \"bank_details\": {\n      \"key_0\": \"string\",\n      \"key_1\": \"string\",\n      \"key_2\": \"string\"\n    },\n    \"memo\": \"\",\n    \"network\": \"ETH\"\n  }\n]",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "85f0854f-517f-40b9-ae12-a2f260ef4fcd",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "deposit-instructions"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "asset",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "a532e6c1-37bd-41b2-80aa-9c01eb04f6ab",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "deposit-instructions"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "asset",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1e8e5db4-7b1a-4899-9354-026d2394642a",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "deposit-instructions"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "asset",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "0506eb9a-1d62-4bfc-a317-7601445814cc",
              "name": "- `asset_invalid`: `asset` is missing or not 2 to 10 letters and digits.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "deposit-instructions"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "asset",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f23b1623-d59d-4872-9280-48981902caea",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "deposit-instructions"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "asset",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7c0c26e9-5e01-4040-8b4b-06f8e81ab23e",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "deposit-instructions"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "asset",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f247a254-38d8-4c35-9b6b-83a8e1db0cbb",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "deposit-instructions"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "asset",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "5f1f9be2-8679-4545-b400-88f3e0418f10",
      "name": "Beneficiaries",
      "description": {
        "content": "The parties the Customer pays: an outside party, its own account elsewhere, or another Customer added by its Receiving Code.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "b22ee88d-3596-4cbd-bfe5-c97a235d921f",
          "name": "List Beneficiaries",
          "request": {
            "name": "List Beneficiaries",
            "description": {
              "content": "Every Beneficiary of the Customer, in each state: `pending_verification` (waiting for the operations team), `verified` (it can be quoted and paid) or `blocked` (final). Another Customer added by its Receiving Code shows only `account_hint`, never its account, and `available` says whether it can be paid now.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "beneficiaries"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "d00bcecc-ae25-4d8f-a21e-88d94eb5bd52",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "[\n  {\n    \"asset\": \"EUR\",\n    \"available\": true,\n    \"country\": \"DE\",\n    \"created_at\": \"2026-11-12T08:02:11Z\",\n    \"details\": {\n      \"iban\": \"DE89370400440532013000\",\n      \"name\": \"Berlin Supplies GmbH\"\n    },\n    \"id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n    \"kind\": \"external\",\n    \"name\": \"Berlin Supplies GmbH\",\n    \"party_type\": \"business\",\n    \"state\": \"verified\",\n    \"updated_at\": \"2026-11-12T08:15:00Z\",\n    \"account_hint\": \"3000\",\n    \"delivers_to\": \"bank_account\",\n    \"verified_at\": \"2026-11-12T08:15:00Z\"\n  },\n  {\n    \"asset\": \"EUR\",\n    \"available\": true,\n    \"country\": \"DE\",\n    \"created_at\": \"2026-11-12T08:02:11Z\",\n    \"details\": {\n      \"iban\": \"DE89370400440532013000\",\n      \"name\": \"Berlin Supplies GmbH\"\n    },\n    \"id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n    \"kind\": \"external\",\n    \"name\": \"Berlin Supplies GmbH\",\n    \"party_type\": \"business\",\n    \"state\": \"verified\",\n    \"updated_at\": \"2026-11-12T08:15:00Z\",\n    \"account_hint\": \"3000\",\n    \"delivers_to\": \"bank_account\",\n    \"verified_at\": \"2026-11-12T08:15:00Z\"\n  }\n]",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "3e15c6fe-8b90-42e5-95ea-c17aa54e49b7",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "2e9972c1-50a9-454a-909f-3ce083812024",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "a01deb3b-5549-46fb-a427-7de992e8288f",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d1e69ed5-98d3-4543-95fc-cf53f889c8b2",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e538e397-fb44-4129-a88b-60e642898970",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "fd008fef-5580-4a9b-84f1-6a3cf61a606b",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "8fc78198-c8e3-47b4-9410-5e739b72d842",
          "name": "Register a Beneficiary",
          "request": {
            "name": "Register a Beneficiary",
            "description": {
              "content": "Registers a party the Customer will pay: `external` (an outside person or business) or `own_account` (the Customer's own account elsewhere, which needs `proof_reference`, a reference to the evidence that the account is the Customer's). `details` holds the account fields the Rails to its country and asset ask for, such as `iban` for a SEPA payout, or `account_number` and `bank_code`; a key no such Rail asks for is refused.\n\nThe Beneficiary starts `pending_verification`; the operations team verifies it, and the `beneficiary.updated` webhook says when it can be quoted and paid. To pay another Customer of the platform, add it with `POST /v1/beneficiaries/link` instead.\n\nRequires the `customer:beneficiaries:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "beneficiaries"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"asset\": \"<string>\",\n  \"country\": \"<string>\",\n  \"kind\": \"<string>\",\n  \"name\": \"<string>\",\n  \"party_type\": \"<string>\",\n  \"details\": {\n    \"key_0\": \"<string>\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "5649b9ca-abe8-4b1f-bf0f-97b7439d6f8a",
              "name": "Created",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"asset\": \"EUR\",\n  \"available\": true,\n  \"country\": \"DE\",\n  \"created_at\": \"2026-11-12T08:02:11Z\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"state\": \"verified\",\n  \"updated_at\": \"2026-11-12T08:15:00Z\",\n  \"account_hint\": \"3000\",\n  \"delivers_to\": \"bank_account\",\n  \"verified_at\": \"2026-11-12T08:15:00Z\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "190ff986-843b-448c-a579-41b49f8c5508",
              "name": "- `bad_request`: The body is not valid JSON.\n- `validation_failed`: `kind`, `party_type`, `name`, `country` (two letters) or `asset` is missing or malformed, or `details` has more than 20 entries or one too long.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "67fcf115-20d6-4505-b3c2-b7860002c140",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e70f589c-168b-4674-802f-1fe78dd841da",
              "name": "- `forbidden`: The API key does not hold the `customer:beneficiaries:write` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b57bff3f-0094-4e9e-a612-6d362c61d956",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f457ceb2-770d-4904-9fa6-ceb6a6779932",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6285df14-dc2f-46cd-ad66-d0aa156c2151",
              "name": "- `beneficiary_fields_invalid`: A key of `details` is not a field the Rails to that country and asset ask for; `details` of the error names each.\n- `iban_invalid`: `details.iban` is not a valid IBAN.\n- `proof_required`: An `own_account` Beneficiary needs `proof_reference`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "80a566c4-15a2-43db-9bfe-0580a024ba12",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "61308953-38cf-4a60-8615-af3dbffa49ed",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "48cea361-4c06-4923-bf0d-9db47eba3b68",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"asset\": \"EUR\",\n  \"country\": \"DE\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"proof_reference\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "724f8cdc-2205-4ebf-9686-3b2aa17fdee6",
          "name": "Add another Customer by its Receiving Code",
          "request": {
            "name": "Add another Customer by its Receiving Code",
            "description": {
              "content": "Adds the Customer that gave this Receiving Code as a Beneficiary. It is verified at once and is paid wherever that Customer receives, its balance or its Receiving Account, read again at every Payout, so its account details are never shown: `account_hint` carries the last four characters. Answers 201 with the new Beneficiary, or 200 with the one already there when this Customer linked that receiver before.\n\nRequires the `customer:beneficiaries:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "beneficiaries",
                "link"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"receiving_code\": \"<string>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "b0eecc5f-d679-43ed-937d-abab57fa79dd",
              "name": "This receiver was linked before.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"asset\": \"EUR\",\n  \"available\": true,\n  \"country\": \"DE\",\n  \"created_at\": \"2026-11-12T08:02:11Z\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"state\": \"verified\",\n  \"updated_at\": \"2026-11-12T08:15:00Z\",\n  \"account_hint\": \"3000\",\n  \"delivers_to\": \"bank_account\",\n  \"verified_at\": \"2026-11-12T08:15:00Z\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "53995e5b-9d48-4030-8768-3bf5ed3313cc",
              "name": "Created",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"asset\": \"EUR\",\n  \"available\": true,\n  \"country\": \"DE\",\n  \"created_at\": \"2026-11-12T08:02:11Z\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"state\": \"verified\",\n  \"updated_at\": \"2026-11-12T08:15:00Z\",\n  \"account_hint\": \"3000\",\n  \"delivers_to\": \"bank_account\",\n  \"verified_at\": \"2026-11-12T08:15:00Z\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7a76e9c4-dbc2-414b-a921-295fa0c74e0a",
              "name": "- `bad_request`: The body is not valid JSON.\n- `validation_failed`: `receiving_code` is missing or longer than 32 characters.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7c829f32-1715-46e5-8894-d93ade2ab486",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "4441533d-1e00-425e-bec2-7547431746c6",
              "name": "- `forbidden`: The API key does not hold the `customer:beneficiaries:write` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c63a2969-47c6-4607-a9e8-65e38ae9c91b",
              "name": "- `receiving_code_not_found`: The code is unknown, was replaced by a newer one, or its Customer cannot receive Payouts now.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "eac44332-e856-4e66-a131-a599b14f6d99",
              "name": "- `receiving_account_missing`: The receiving Customer has no Receiving Account to be paid into yet.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e097ff9a-4bcf-4e13-a481-bff9a312ee58",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "42e41559-0901-47af-be50-e9528a4cf71e",
              "name": "- `cannot_link_self`: The code is the Customer's own.\n- `linked_customer_not_active`: The receiving Customer stopped being active.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "4f08cadc-836d-4cbf-a7ed-014acf6311cb",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "317135df-6276-4719-8b4f-bf0dc2ae7ee7",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "0d88c25b-a376-4d34-81aa-8532fb2b589c",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    "link"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"receiving_code\": \"RC-7KQ2-M9XD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "09db0725-7ee6-4a84-ba39-5f78cb79d9e3",
          "name": "Get a Beneficiary",
          "request": {
            "name": "Get a Beneficiary",
            "description": {
              "content": "One of the Customer's Beneficiaries, as `GET /v1/beneficiaries` lists it.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "beneficiaries",
                ":id"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The Beneficiary's id."
                }
              ]
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "feb90d6a-5ce2-486d-a3d4-b4213d7a4a12",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Beneficiary's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"asset\": \"EUR\",\n  \"available\": true,\n  \"country\": \"DE\",\n  \"created_at\": \"2026-11-12T08:02:11Z\",\n  \"details\": {\n    \"iban\": \"DE89370400440532013000\",\n    \"name\": \"Berlin Supplies GmbH\"\n  },\n  \"id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"kind\": \"external\",\n  \"name\": \"Berlin Supplies GmbH\",\n  \"party_type\": \"business\",\n  \"state\": \"verified\",\n  \"updated_at\": \"2026-11-12T08:15:00Z\",\n  \"account_hint\": \"3000\",\n  \"delivers_to\": \"bank_account\",\n  \"verified_at\": \"2026-11-12T08:15:00Z\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "74357c5e-433c-44f1-9ffc-f688655e8af4",
              "name": "- `invalid_id`: `id` is not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Beneficiary's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "fbda7282-a98f-4d69-afac-6ef99164d27f",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Beneficiary's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "ec68bacf-38ae-42f3-80a8-1adef6d81b51",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Beneficiary's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1334ffd2-5325-4fd6-96e3-283f0db522ad",
              "name": "- `beneficiary_not_found`: No Beneficiary of this Customer has this id.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Beneficiary's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "3c3ab824-74d7-412e-8ba8-6627c518f6fc",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Beneficiary's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "63dbf3f0-399e-4da6-8f10-abeb308a58b1",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Beneficiary's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "532732a9-3281-4255-9436-ca2c963ec35f",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "beneficiaries",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Beneficiary's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "cfce1c91-0dc8-4de2-b962-78f751609f78",
      "name": "Quotes",
      "description": {
        "content": "What sending an amount to a Beneficiary would cost and deliver, one Quote per eligible Route, each valid for a short time.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "1fd2d436-3472-4042-b391-9d2908886c87",
          "name": "Quote a payment to a Beneficiary",
          "request": {
            "name": "Quote a payment to a Beneficiary",
            "description": {
              "content": "Prices sending `amount` of `source_asset` from the Customer's balance to one of its Beneficiaries, in the Beneficiary's country and asset. The answer holds one Quote per eligible Route: what the Beneficiary receives, every fee line and rate passed through, the Providers in order, the estimated arrival and `expires_at`. The Quote that delivers most is labelled `cheapest` and the one that settles soonest `fastest` (one Quote may carry both); `preference` only decides which comes first. Accept one with `POST /v1/payouts` and its `quote_id` before it expires, counting the time left from `server_time` rather than your own clock.\n\nWhen no Route is eligible the answer is still 201, with no Quotes and an `unavailable_reason`:\n- `beneficiary_not_verified`: the Beneficiary waits for verification or is blocked, or is another Customer that cannot be paid now;\n- `onboarding_required`: a Provider on the Route has not approved the Customer yet;\n- `funds_at_other_provider`: the Customer holds the amount, but at another Provider than the Routes start at; `deposit_at` names the Providers to deposit the asset at instead (see `GET /v1/deposit-instructions`);\n- `temporarily_unavailable`: a Route exists but cannot be used for now; try again later;\n- `amount_out_of_range`: the amount is outside what the Routes take, or does not cover their fees;\n- `no_route`: nothing serves this asset and destination for this Customer.\n\nWorked example: 1000 USDC to a Beneficiary in Germany paid in EUR by SEPA Instant is a 1 USDC conversion fee, the rate 0.92 and a 0.5 EUR payout fee: 918.58 EUR arrive.\n\nRequires the `customer:payouts:create` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "quotes"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"amount\": \"<string>\",\n  \"beneficiary_id\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"source_asset\": \"<string>\",\n  \"preference\": \"<string>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "cfc92008-2b93-460b-8a16-906bf6046a6c",
              "name": "Created",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"quotes\": [\n    {\n      \"estimated_arrival\": \"2026-11-12T09:31:00Z\",\n      \"expires_at\": \"2026-11-12T09:30:30Z\",\n      \"fees\": [\n        {\n          \"amount\": {\n            \"amount\": \"1\",\n            \"asset\": \"USDC\"\n          },\n          \"component\": \"provider\",\n          \"provider\": \"bvnk\"\n        },\n        {\n          \"amount\": {\n            \"amount\": \"0.5\",\n            \"asset\": \"EUR\"\n          },\n          \"component\": \"provider\",\n          \"provider\": \"bvnk\"\n        }\n      ],\n      \"labels\": [\n        \"cheapest\",\n        \"fastest\"\n      ],\n      \"providers\": [\n        \"bvnk\"\n      ],\n      \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\",\n      \"rates\": [\n        {\n          \"provider\": \"bvnk\",\n          \"rate\": \"0.92\"\n        }\n      ],\n      \"receive\": {\n        \"amount\": \"918.58\",\n        \"asset\": \"EUR\"\n      },\n      \"send\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"settlement_seconds\": 90\n    },\n    {\n      \"estimated_arrival\": \"2026-11-12T09:31:00Z\",\n      \"expires_at\": \"2026-11-12T09:30:30Z\",\n      \"fees\": [\n        {\n          \"amount\": {\n            \"amount\": \"1\",\n            \"asset\": \"USDC\"\n          },\n          \"component\": \"provider\",\n          \"provider\": \"bvnk\"\n        },\n        {\n          \"amount\": {\n            \"amount\": \"0.5\",\n            \"asset\": \"EUR\"\n          },\n          \"component\": \"provider\",\n          \"provider\": \"bvnk\"\n        }\n      ],\n      \"labels\": [\n        \"cheapest\",\n        \"fastest\"\n      ],\n      \"providers\": [\n        \"bvnk\"\n      ],\n      \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\",\n      \"rates\": [\n        {\n          \"provider\": \"bvnk\",\n          \"rate\": \"0.92\"\n        }\n      ],\n      \"receive\": {\n        \"amount\": \"918.58\",\n        \"asset\": \"EUR\"\n      },\n      \"send\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"settlement_seconds\": 90\n    }\n  ],\n  \"server_time\": \"2026-11-12T09:29:30Z\",\n  \"deposit_at\": [\n    \"bvnk\"\n  ],\n  \"quote_set_id\": \"4f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f\",\n  \"unavailable_reason\": \"no_route\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "ddaec40b-f153-47f4-a006-078dd20e0802",
              "name": "- `bad_request`: The body is not valid JSON.\n- `validation_failed`: `source_asset`, `amount`, `beneficiary_id` or `purpose` is missing or malformed, or `preference` is neither `cheapest` nor `fastest`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c3eaa24d-9554-480f-9ea0-39c30f4ce145",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "bc8dadf7-d873-4172-bd00-678256fd69fb",
              "name": "- `forbidden`: The API key does not hold the `customer:payouts:create` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "480934bf-a788-4b70-968d-13a031f13011",
              "name": "- `beneficiary_not_found`: `beneficiary_id` is not one of the Customer's Beneficiaries.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "ddbb8278-16ce-458b-a042-fb6509b904dc",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d3643488-43f8-4b33-8144-66c496da3908",
              "name": "- `bad_amount`: `amount` is not a positive decimal number.\n- `amount_scale`: `amount` has more decimals than the asset allows: 6 for USDT, USDC and EURC, 2 for the others.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "cdc33127-8f35-4c20-b8cc-267184d975ba",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c3d3bc51-80d2-4df8-92f3-8a1217584773",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7e6c896e-15fb-46a5-a026-b76806c9f694",
              "name": "- `quote_unavailable`: A Provider could not price a Route; retry shortly.\n- `policy_unavailable`: The quote could not be completed for a moment; retry shortly.\n- `prerequisites_unavailable`: The quote could not be completed for a moment; retry shortly.\n- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f808b8b6-adc3-4207-843d-9c7bdf563cc2",
              "name": "- `beneficiaries_unavailable`: The quote could not be completed for a moment; retry shortly.\n- `customers_unavailable`: The quote could not be completed for a moment; retry shortly.\n- `funds_unavailable`: The quote could not be completed for a moment; retry shortly.\n- `pricing_unavailable`: The quote could not be completed for a moment; retry shortly.\n- `float_unavailable`: The quote could not be completed for a moment; retry shortly.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "quotes"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"amount\": \"1000\",\n  \"beneficiary_id\": \"7a1e4c2b-9d3f-4e8a-b6c5-1f2e3d4c5b6a\",\n  \"purpose\": \"supplier\",\n  \"source_asset\": \"USDC\",\n  \"preference\": \"cheapest\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Service Unavailable",
              "code": 503,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "ada59858-1d6c-45ad-811d-237deb728f4a",
      "name": "Payouts",
      "description": {
        "content": "Accepting a Quote into a Payout, following it to completion, and cancelling it while nothing is reserved for it.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "40ba54b7-d8c8-4b83-91d5-de916c68a241",
          "name": "List Payouts",
          "request": {
            "name": "List Payouts",
            "description": {
              "content": "The Customer's Payouts, newest first, one page at a time. Pass `next_cursor` back as `cursor` for the next page; it is absent on the last one.\n\nA Payout's `state` is one of `awaiting_approval` (held by the Customer's approval rules for a second person), `accepted` (waiting for funds at the Provider its Route starts at), `funded`, `processing`, `completed`, `failed` (it stopped and waits for the operations team to retry or refund it), `refunded` or `cancelled`. `completed`, `refunded` and `cancelled` are final.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "payouts"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [
                {
                  "disabled": true,
                  "key": "state",
                  "value": "<string>",
                  "description": "Only Payouts in this state."
                },
                {
                  "disabled": true,
                  "key": "limit",
                  "value": "50",
                  "description": "How many Payouts one page holds."
                },
                {
                  "disabled": true,
                  "key": "cursor",
                  "value": "<string>",
                  "description": "The `next_cursor` of the previous page; leave it out for the first page."
                }
              ],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "daa4a9fe-1fac-42f9-8e8a-09bdef501ff4",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"payouts\": [\n    {\n      \"beneficiary\": {\n        \"country\": \"DE\",\n        \"name\": \"Berlin Supplies GmbH\",\n        \"party_type\": \"business\"\n      },\n      \"cancellable\": false,\n      \"created_at\": \"2026-11-12T09:30:02Z\",\n      \"delivered_to\": \"bank_account\",\n      \"fees\": [\n        {\n          \"amount\": {\n            \"amount\": \"1\",\n            \"asset\": \"USDC\"\n          },\n          \"component\": \"provider\",\n          \"provider\": \"bvnk\"\n        },\n        {\n          \"amount\": {\n            \"amount\": \"0.5\",\n            \"asset\": \"EUR\"\n          },\n          \"component\": \"provider\",\n          \"provider\": \"bvnk\"\n        }\n      ],\n      \"id\": \"5f8d0c3e-2b7a-4d1e-9c6f-8a3b2e1d0c9f\",\n      \"initiated_by\": {\n        \"actor\": \"customer\",\n        \"kind\": \"api_key\"\n      },\n      \"legs\": [\n        {\n          \"from\": \"USDC\",\n          \"index\": 0,\n          \"provider\": \"bvnk\",\n          \"settled_at\": \"2026-11-12T09:30:41Z\",\n          \"state\": \"completed\",\n          \"to\": \"EUR\"\n        },\n        {\n          \"from\": \"EUR\",\n          \"index\": 1,\n          \"provider\": \"bvnk\",\n          \"settled_at\": \"2026-11-12T09:31:05Z\",\n          \"state\": \"completed\",\n          \"to\": \"EUR\"\n        }\n      ],\n      \"rates\": [\n        {\n          \"provider\": \"bvnk\",\n          \"rate\": \"0.92\"\n        }\n      ],\n      \"receive\": {\n        \"amount\": \"918.58\",\n        \"asset\": \"EUR\"\n      },\n      \"send\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"state\": \"completed\",\n      \"updated_at\": \"2026-11-12T09:31:05Z\",\n      \"failure\": {\n        \"code\": \"rate_moved\",\n        \"leg\": 1\n      },\n      \"initiated_by_you\": true\n    },\n    {\n      \"beneficiary\": {\n        \"country\": \"DE\",\n        \"name\": \"Berlin Supplies GmbH\",\n        \"party_type\": \"business\"\n      },\n      \"cancellable\": false,\n      \"created_at\": \"2026-11-12T09:30:02Z\",\n      \"delivered_to\": \"bank_account\",\n      \"fees\": [\n        {\n          \"amount\": {\n            \"amount\": \"1\",\n            \"asset\": \"USDC\"\n          },\n          \"component\": \"provider\",\n          \"provider\": \"bvnk\"\n        },\n        {\n          \"amount\": {\n            \"amount\": \"0.5\",\n            \"asset\": \"EUR\"\n          },\n          \"component\": \"provider\",\n          \"provider\": \"bvnk\"\n        }\n      ],\n      \"id\": \"5f8d0c3e-2b7a-4d1e-9c6f-8a3b2e1d0c9f\",\n      \"initiated_by\": {\n        \"actor\": \"customer\",\n        \"kind\": \"api_key\"\n      },\n      \"legs\": [\n        {\n          \"from\": \"USDC\",\n          \"index\": 0,\n          \"provider\": \"bvnk\",\n          \"settled_at\": \"2026-11-12T09:30:41Z\",\n          \"state\": \"completed\",\n          \"to\": \"EUR\"\n        },\n        {\n          \"from\": \"EUR\",\n          \"index\": 1,\n          \"provider\": \"bvnk\",\n          \"settled_at\": \"2026-11-12T09:31:05Z\",\n          \"state\": \"completed\",\n          \"to\": \"EUR\"\n        }\n      ],\n      \"rates\": [\n        {\n          \"provider\": \"bvnk\",\n          \"rate\": \"0.92\"\n        }\n      ],\n      \"receive\": {\n        \"amount\": \"918.58\",\n        \"asset\": \"EUR\"\n      },\n      \"send\": {\n        \"amount\": \"1000\",\n        \"asset\": \"USDC\"\n      },\n      \"state\": \"completed\",\n      \"updated_at\": \"2026-11-12T09:31:05Z\",\n      \"failure\": {\n        \"code\": \"rate_moved\",\n        \"leg\": 1\n      },\n      \"initiated_by_you\": true\n    }\n  ],\n  \"next_cursor\": \"eyJhdCI6IjIwMjYtMTEtMTJUMDk6MzA6MDJaIn0\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6ffc04ae-2048-4520-95fe-a26ffb236929",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "47ccf006-e0a9-4d70-8097-706c103fe833",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "62e9bab0-10bc-4d20-a8d0-3bf79318027c",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "fdf2081b-dd54-4966-b5b2-8f3e0dbc2072",
              "name": "- `bad_limit`: `limit` is not a whole number from 1 to 100.\n- `bad_cursor`: `cursor` is not a `next_cursor` this list answered.\n- `unknown_state`: `state` is not one of the Payout states.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b0274042-0450-428d-b1fe-424b7acb7ec5",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "a4009bee-9b58-46fb-b6de-97ffaa1cdee4",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "bc9e66e8-e2c0-4aab-a3df-8eab8c46172d",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "e8c99dd6-12a7-4746-a69a-da4cd926c170",
          "name": "Accept a Quote into a Payout",
          "request": {
            "name": "Accept a Quote into a Payout",
            "description": {
              "content": "Accepts one Quote of a quote set, named by its `quote_id`, before its `expires_at`. The answer is the new Payout, in one of these states:\n- `awaiting_approval`: the Customer's approval rules hold it until a second person of the Customer approves it in the Customer panel;\n- `accepted`: the balance at the Provider its Route starts at does not cover the send amount yet; the next Deposit there funds it, and it is cancelled if the Quote ends first (money held at another Provider is never combined);\n- `funded` or `processing`: the money was there and the Payout is on its way.\n\nFollow it with `GET /v1/payouts/{id}` or the `payout.updated` webhook. One `quote_id` makes one Payout. When an answer is lost or is a 5xx, retry with the same `Idempotency-Key`; if the retry answers `quote_already_used`, the Payout exists: find it with `GET /v1/payouts`.\n\nRequires the `customer:payouts:create` permission. Send an `Idempotency-Key`: a retry with the same key and body answers the first response again (marked `Idempotency-Replayed: true`) for 24 hours. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "payouts"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "disabled": false,
                "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                "key": "Idempotency-Key",
                "value": "<string>"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"quote_id\": \"<string>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "d3bbd988-cbdf-4560-b0a0-d955548dc5b8",
              "name": "Created",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "disabled": true,
                  "description": "`true` when this answer is the stored response to an earlier request with the same `Idempotency-Key`.",
                  "key": "Idempotency-Replayed",
                  "value": "true"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"beneficiary\": {\n    \"country\": \"DE\",\n    \"name\": \"Berlin Supplies GmbH\",\n    \"party_type\": \"business\"\n  },\n  \"cancellable\": false,\n  \"created_at\": \"2026-11-12T09:30:02Z\",\n  \"delivered_to\": \"bank_account\",\n  \"fees\": [\n    {\n      \"amount\": {\n        \"amount\": \"1\",\n        \"asset\": \"USDC\"\n      },\n      \"component\": \"provider\",\n      \"provider\": \"bvnk\"\n    },\n    {\n      \"amount\": {\n        \"amount\": \"0.5\",\n        \"asset\": \"EUR\"\n      },\n      \"component\": \"provider\",\n      \"provider\": \"bvnk\"\n    }\n  ],\n  \"id\": \"5f8d0c3e-2b7a-4d1e-9c6f-8a3b2e1d0c9f\",\n  \"initiated_by\": {\n    \"actor\": \"customer\",\n    \"kind\": \"api_key\"\n  },\n  \"legs\": [\n    {\n      \"from\": \"USDC\",\n      \"index\": 0,\n      \"provider\": \"bvnk\",\n      \"settled_at\": \"2026-11-12T09:30:41Z\",\n      \"state\": \"completed\",\n      \"to\": \"EUR\"\n    },\n    {\n      \"from\": \"EUR\",\n      \"index\": 1,\n      \"provider\": \"bvnk\",\n      \"settled_at\": \"2026-11-12T09:31:05Z\",\n      \"state\": \"completed\",\n      \"to\": \"EUR\"\n    }\n  ],\n  \"rates\": [\n    {\n      \"provider\": \"bvnk\",\n      \"rate\": \"0.92\"\n    }\n  ],\n  \"receive\": {\n    \"amount\": \"918.58\",\n    \"asset\": \"EUR\"\n  },\n  \"send\": {\n    \"amount\": \"1000\",\n    \"asset\": \"USDC\"\n  },\n  \"state\": \"completed\",\n  \"updated_at\": \"2026-11-12T09:31:05Z\",\n  \"failure\": {\n    \"code\": \"rate_moved\",\n    \"leg\": 1\n  },\n  \"initiated_by_you\": true\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "28a4c995-ba16-4944-a237-51e479e79fd9",
              "name": "- `bad_request`: The body is not valid JSON.\n- `validation_failed`: `quote_id` is missing or longer than 4096 characters.\n- `idempotency_key_required`: The `Idempotency-Key` header is missing.\n- `idempotency_key_invalid`: The `Idempotency-Key` header is longer than 128 characters.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "783927d4-390c-4fe4-a2fe-8891d47c16c5",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e9068766-f442-4e8c-8254-91044efbcb28",
              "name": "- `forbidden`: The API key does not hold the `customer:payouts:create` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "5e46a4b3-00ad-4cc8-8a7f-7e7d8cad6ac6",
              "name": "- `quote_not_found`: The Route the Quote was for is no longer offered; ask for a new Quote.\n- `decision_not_found`: The quote set behind `quote_id` no longer exists; ask for a new Quote.\n- `beneficiary_not_found`: The Quote's Beneficiary is no longer the Customer's.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "665c1269-163f-485d-bab5-d76bdf605697",
              "name": "- `quote_already_used`: A Payout was already made from this `quote_id`.\n- `beneficiary_unavailable`: The Beneficiary is another Customer that cannot be paid now.\n- `beneficiary_changed`: The Beneficiary is another Customer whose country, asset or account changed since the Quote; ask for a new Quote.\n- `idempotency_in_progress`: A request with the same `Idempotency-Key` is still being processed; retry in a moment.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7d0e309e-33bb-4d39-b31c-d066b9aa783f",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "165b7d64-9345-4872-aec9-cce9cfe3d8cc",
              "name": "- `quote_token_invalid`: `quote_id` is not one this API issued to this Customer (or, acting for an End Customer, to that End Customer).\n- `quote_expired`: The Quote passed its `expires_at`, or the Provider its Route starts at can no longer be reached; ask for a new Quote.\n- `beneficiary_not_verified`: The Beneficiary is no longer verified.\n- `customer_not_active`: The Customer, or its Platform, stopped being active.\n- `quote_inconsistent`: The Route's Providers changed since the Quote; ask for a new Quote.\n- `idempotency_key_reused`: The `Idempotency-Key` was already used with a different request body.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8d6c3f35-a4e4-4015-97aa-afe6ee592828",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "68147757-73e7-4030-bf6e-5713a892438d",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "748b1da5-862c-4615-988d-30dd5e7a949e",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "378c316b-5b07-4953-81bb-cdb86fc14a16",
              "name": "- `approval_rules_unavailable`: The approval rules could not be read for a moment; retry with the same `Idempotency-Key`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"quote_id\": \"qt1.eyJkZWNpc2lvbl9pZCI6IjRmOWU4ZDdjIn0.k3Jv9zQh1sX0pL2mN8bR4tY6uW5aE7cD\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Service Unavailable",
              "code": 503,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "f2ec8018-cf95-40e9-91a9-845e020b0ca3",
          "name": "Get a Payout",
          "request": {
            "name": "Get a Payout",
            "description": {
              "content": "One of the Customer's Payouts with its Legs (one per Provider step of its Route), fees, rates and timeline: every state it passed through, when, and who moved it (`customer` for the Customer's own people and API keys, `operations` for the operations team, `system` for the platform itself). `cancellable` says whether `POST /v1/payouts/{id}/cancel` would succeed now; `failure` names the Leg that failed and why.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "payouts",
                ":id"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The Payout's id."
                }
              ]
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "7650c771-f29f-4765-90c2-a6f39854622c",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"beneficiary\": {\n    \"country\": \"DE\",\n    \"name\": \"Berlin Supplies GmbH\",\n    \"party_type\": \"business\"\n  },\n  \"cancellable\": false,\n  \"created_at\": \"2026-11-12T09:30:02Z\",\n  \"delivered_to\": \"bank_account\",\n  \"fees\": [\n    {\n      \"amount\": {\n        \"amount\": \"1\",\n        \"asset\": \"USDC\"\n      },\n      \"component\": \"provider\",\n      \"provider\": \"bvnk\"\n    },\n    {\n      \"amount\": {\n        \"amount\": \"0.5\",\n        \"asset\": \"EUR\"\n      },\n      \"component\": \"provider\",\n      \"provider\": \"bvnk\"\n    }\n  ],\n  \"id\": \"5f8d0c3e-2b7a-4d1e-9c6f-8a3b2e1d0c9f\",\n  \"initiated_by\": {\n    \"actor\": \"customer\",\n    \"kind\": \"api_key\"\n  },\n  \"legs\": [\n    {\n      \"from\": \"USDC\",\n      \"index\": 0,\n      \"provider\": \"bvnk\",\n      \"settled_at\": \"2026-11-12T09:30:41Z\",\n      \"state\": \"completed\",\n      \"to\": \"EUR\"\n    },\n    {\n      \"from\": \"EUR\",\n      \"index\": 1,\n      \"provider\": \"bvnk\",\n      \"settled_at\": \"2026-11-12T09:31:05Z\",\n      \"state\": \"completed\",\n      \"to\": \"EUR\"\n    }\n  ],\n  \"rates\": [\n    {\n      \"provider\": \"bvnk\",\n      \"rate\": \"0.92\"\n    }\n  ],\n  \"receive\": {\n    \"amount\": \"918.58\",\n    \"asset\": \"EUR\"\n  },\n  \"send\": {\n    \"amount\": \"1000\",\n    \"asset\": \"USDC\"\n  },\n  \"state\": \"completed\",\n  \"timeline\": [\n    {\n      \"at\": \"2026-11-12T09:30:02Z\",\n      \"by\": {\n        \"actor\": \"customer\",\n        \"kind\": \"api_key\"\n      },\n      \"state\": \"accepted\"\n    },\n    {\n      \"at\": \"2026-11-12T09:30:02Z\",\n      \"by\": {\n        \"actor\": \"system\"\n      },\n      \"state\": \"funded\"\n    },\n    {\n      \"at\": \"2026-11-12T09:30:03Z\",\n      \"by\": {\n        \"actor\": \"system\"\n      },\n      \"state\": \"processing\"\n    },\n    {\n      \"at\": \"2026-11-12T09:31:05Z\",\n      \"by\": {\n        \"actor\": \"system\"\n      },\n      \"state\": \"completed\"\n    }\n  ],\n  \"updated_at\": \"2026-11-12T09:31:05Z\",\n  \"failure\": {\n    \"code\": \"rate_moved\",\n    \"leg\": 1\n  },\n  \"initiated_by_you\": true\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "a9ca5c69-5865-439e-b871-9b4f456566e2",
              "name": "- `invalid_id`: `id` is not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "a21059fd-7e86-48b3-bb93-83be3e9fdf1b",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "212e3220-a408-4353-aa9a-359c8abf8df9",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "77359f47-acbd-4f64-8bb7-ad2c8fbdf119",
              "name": "- `payout_not_found`: No Payout of this Customer has this id.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "81e43c18-4303-40e6-9329-18b3e5f9f291",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1bfde43d-5d60-4c45-b611-b6d1e67f83b9",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "15b9c6fa-8725-4ef5-a7f4-347db3376f72",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "727bf5f7-1c54-451b-9b2d-072de9ef0b2b",
          "name": "Cancel a Payout",
          "request": {
            "name": "Cancel a Payout",
            "description": {
              "content": "Cancels a Payout nothing has been reserved for yet: one `awaiting_approval`, or `accepted` and still waiting for funds. A funded Payout runs its course. The Payout's `cancellable` says whether this would succeed now. Any of the Customer's people or API keys holding the permission may cancel any of its Payouts.\n\nRequires the `customer:payouts:create` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "payouts",
                ":id",
                "cancel"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The Payout's id."
                }
              ]
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST"
          },
          "response": [
            {
              "id": "96d8a585-9ddb-4a3f-b711-95be3c8c77cf",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id",
                    "cancel"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"beneficiary\": {\n    \"country\": \"DE\",\n    \"name\": \"Berlin Supplies GmbH\",\n    \"party_type\": \"business\"\n  },\n  \"cancellable\": false,\n  \"created_at\": \"2026-11-12T09:30:02Z\",\n  \"delivered_to\": \"bank_account\",\n  \"fees\": [\n    {\n      \"amount\": {\n        \"amount\": \"1\",\n        \"asset\": \"USDC\"\n      },\n      \"component\": \"provider\",\n      \"provider\": \"bvnk\"\n    },\n    {\n      \"amount\": {\n        \"amount\": \"0.5\",\n        \"asset\": \"EUR\"\n      },\n      \"component\": \"provider\",\n      \"provider\": \"bvnk\"\n    }\n  ],\n  \"id\": \"5f8d0c3e-2b7a-4d1e-9c6f-8a3b2e1d0c9f\",\n  \"initiated_by\": {\n    \"actor\": \"customer\",\n    \"kind\": \"api_key\"\n  },\n  \"legs\": [\n    {\n      \"from\": \"USDC\",\n      \"index\": 0,\n      \"provider\": \"bvnk\",\n      \"settled_at\": \"2026-11-12T09:30:41Z\",\n      \"state\": \"completed\",\n      \"to\": \"EUR\"\n    },\n    {\n      \"from\": \"EUR\",\n      \"index\": 1,\n      \"provider\": \"bvnk\",\n      \"settled_at\": \"2026-11-12T09:31:05Z\",\n      \"state\": \"completed\",\n      \"to\": \"EUR\"\n    }\n  ],\n  \"rates\": [\n    {\n      \"provider\": \"bvnk\",\n      \"rate\": \"0.92\"\n    }\n  ],\n  \"receive\": {\n    \"amount\": \"918.58\",\n    \"asset\": \"EUR\"\n  },\n  \"send\": {\n    \"amount\": \"1000\",\n    \"asset\": \"USDC\"\n  },\n  \"state\": \"completed\",\n  \"updated_at\": \"2026-11-12T09:31:05Z\",\n  \"failure\": {\n    \"code\": \"rate_moved\",\n    \"leg\": 1\n  },\n  \"initiated_by_you\": true\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6759c99f-7670-4789-bd34-8b55f7ed1e4f",
              "name": "- `invalid_id`: `id` is not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id",
                    "cancel"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "42448355-e638-40bd-809f-006556df0c0e",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id",
                    "cancel"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "55613817-f046-4bc2-aba4-53eff32ec591",
              "name": "- `forbidden`: The API key does not hold the `customer:payouts:create` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id",
                    "cancel"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "64e07a1a-7ea5-4dd2-b30b-8b621a062c2d",
              "name": "- `payout_not_found`: No Payout of this Customer has this id.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id",
                    "cancel"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "707b859a-bfa3-438b-8674-4da87b5742d3",
              "name": "- `payout_not_cancellable`: The Payout is funded, on its way or finished.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id",
                    "cancel"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "21edc7e9-2138-4ac8-9def-b10e2e612606",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id",
                    "cancel"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b213c3f9-cf0f-4ce9-b726-700571aa196c",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id",
                    "cancel"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c1adb508-8917-4f8a-ab09-2c828f71861b",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "payouts",
                    ":id",
                    "cancel"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "26fe17dc-793a-4f31-a281-2dd7ff268ba0",
      "name": "Receiving",
      "description": {
        "content": "Being paid by other Customers: the Receiving Code the Customer hands out and the account those Payouts are paid into.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "11494def-a9c7-498d-be74-c040d855d9eb",
          "name": "Get the Receiving Code and account",
          "request": {
            "name": "Get the Receiving Code and account",
            "description": {
              "content": "The Receiving Code the Customer hands to other Customers of the platform so they can pay it, and its Receiving Account, the verified own account those Payouts are paid into. Where the platform credits such Payouts to the Customer's balance instead, `credit_asset` names the asset, and no Receiving Account is needed. `code` and `account` are null until the Customer has one; an account blocked after it was chosen reads null.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "receiving"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "7a4e1311-5139-4c63-9c97-615e268b882e",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"account\": {\n    \"account_hint\": \"4321\",\n    \"asset\": \"PKR\",\n    \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\",\n    \"country\": \"PK\",\n    \"name\": \"Lina Qureshi\"\n  },\n  \"code\": \"RC-7KQ2-M9XD\",\n  \"credit_asset\": \"PKR\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "cd4ca214-a911-46ab-a122-b3ea5e3792e5",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "9bb6a406-413e-4273-9c4a-e1b15d39ba7e",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "110c2542-5be9-4711-95ed-5e4b9c1a650a",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "5fbfe972-2862-47f3-ad73-803f928b9cc6",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "607b969a-b270-483f-8129-823a91ff4472",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d0d26d06-673c-4409-945b-975ead70bfed",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "81bd8027-d78c-4e15-aba4-b6395bfd71b3",
          "name": "Choose the Receiving Account",
          "request": {
            "name": "Choose the Receiving Account",
            "description": {
              "content": "Names which of the Customer's verified `own_account` Beneficiaries the Payouts other Customers send it are paid into.\n\nRequires the `customer:beneficiaries:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "receiving",
                "account"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "PUT",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"beneficiary_id\": \"<string>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "2645e714-858b-4808-84ca-3559946237cb",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"account\": {\n    \"account_hint\": \"4321\",\n    \"asset\": \"PKR\",\n    \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\",\n    \"country\": \"PK\",\n    \"name\": \"Lina Qureshi\"\n  },\n  \"code\": \"RC-7KQ2-M9XD\",\n  \"credit_asset\": \"PKR\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b863d91b-af20-4d69-bfd9-83e7839b2492",
              "name": "- `bad_request`: The body is not valid JSON.\n- `validation_failed`: `beneficiary_id` is missing or not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "3f2eaac8-71ce-4904-a2bc-c8ba0963d472",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "aedfb048-c55d-490d-8bc8-7f859d678fca",
              "name": "- `forbidden`: The API key does not hold the `customer:beneficiaries:write` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6bfd636c-75a2-49d6-b4dc-30722eefaeef",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "80d1fa6b-e7d4-4735-9d59-a127cec2309c",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "97aac895-2ee9-46c3-9091-92e4929b1dea",
              "name": "- `receiving_account_invalid`: The Beneficiary is not one of the Customer's verified `own_account` Beneficiaries.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "89be272d-f5a1-4a51-b6e0-bcc0f341fb26",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e0ac2649-1436-4a57-b14c-17709cb9e7f3",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "93e23045-243d-4385-915f-5bdb1d14c5e4",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "account"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "PUT",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "f82584bf-6c53-498e-9cbb-336f14eb49d6",
          "name": "Issue a new Receiving Code",
          "request": {
            "name": "Issue a new Receiving Code",
            "description": {
              "content": "Puts a new Receiving Code in force: the first one, or one replacing the code in force. The old code stops working for new senders; Beneficiaries already made with it keep working.\n\nRequires the `customer:beneficiaries:write` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "receiving",
                "code"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST"
          },
          "response": [
            {
              "id": "5ac1a13a-8fec-4ca0-b93e-11cfee7a7900",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "code"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"account\": {\n    \"account_hint\": \"4321\",\n    \"asset\": \"PKR\",\n    \"beneficiary_id\": \"8c2d5e3f-0a4b-4c9d-8e7f-6a5b4c3d2e1f\",\n    \"country\": \"PK\",\n    \"name\": \"Lina Qureshi\"\n  },\n  \"code\": \"RC-7KQ2-M9XD\",\n  \"credit_asset\": \"PKR\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "0c41483e-0933-43c9-b1aa-9b4f44f22d86",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "code"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "fe7cf30e-2fe8-4aec-8c0b-721aec9c9110",
              "name": "- `forbidden`: The API key does not hold the `customer:beneficiaries:write` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "code"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b2188ce3-5bc2-494f-9114-7f168cabf634",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "code"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "86ade204-e653-4048-812b-477aad166e92",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "code"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d9edaf9b-81d6-4ea9-8a17-d7715f11e4ce",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "code"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "9b95d5bb-0a1d-474d-a3d8-017d0584920d",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "receiving",
                    "code"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "6e66834a-a9ca-4653-a5a6-02391fad5cfd",
      "name": "Incoming payouts",
      "description": {
        "content": "Payouts other Customers sent this Customer, as the receiver sees them.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "61438476-5785-4329-9eb8-16165b4e7c25",
          "name": "List incoming payouts",
          "request": {
            "name": "List incoming payouts",
            "description": {
              "content": "Payouts other Customers sent this Customer by its Receiving Code, newest first, one page at a time.\n\nA Payout appears once its sender's money is held for it, never before and never once cancelled, and reads `on_the_way`, `delivered`, `delayed` (it failed and waits for the sender's side to retry or return it) or `returned` (the money went back to the sender). The sender's send amount, fees, Route and Providers are never shown. The `payout.incoming.updated` webhook announces every change.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "incoming-payouts"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [
                {
                  "disabled": true,
                  "key": "limit",
                  "value": "50",
                  "description": "How many Payouts one page holds."
                },
                {
                  "disabled": true,
                  "key": "cursor",
                  "value": "<string>",
                  "description": "The `next_cursor` of the previous page; leave it out for the first page."
                }
              ],
              "variable": []
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "80526d6f-aa45-4a20-96bb-20eb5df39b13",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"items\": [\n    {\n      \"account_hint\": \"4321\",\n      \"amount\": {\n        \"amount\": \"277664.5\",\n        \"asset\": \"PKR\"\n      },\n      \"created_at\": \"2026-11-12T09:30:02Z\",\n      \"delivered_at\": \"2026-11-12T09:41:17Z\",\n      \"delivered_to\": \"bank_account\",\n      \"id\": \"0e1f2a3b-4c5d-4e6f-8a7b-9c0d1e2f3a4b\",\n      \"purpose\": \"services\",\n      \"sender_name\": \"Tom Becker\",\n      \"status\": \"delivered\",\n      \"updated_at\": \"2026-11-12T09:41:17Z\"\n    },\n    {\n      \"account_hint\": \"4321\",\n      \"amount\": {\n        \"amount\": \"277664.5\",\n        \"asset\": \"PKR\"\n      },\n      \"created_at\": \"2026-11-12T09:30:02Z\",\n      \"delivered_at\": \"2026-11-12T09:41:17Z\",\n      \"delivered_to\": \"bank_account\",\n      \"id\": \"0e1f2a3b-4c5d-4e6f-8a7b-9c0d1e2f3a4b\",\n      \"purpose\": \"services\",\n      \"sender_name\": \"Tom Becker\",\n      \"status\": \"delivered\",\n      \"updated_at\": \"2026-11-12T09:41:17Z\"\n    }\n  ],\n  \"next_cursor\": \"eyJhdCI6IjIwMjYtMTEtMTJUMDk6MzA6MDJaIn0\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6d0cf8b8-88ac-4fad-840a-302a8a3ae055",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "00de4548-49ed-4e32-bc68-a31ac26aab97",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "9a380f4f-68e7-4ba6-bc62-912c5022bb0c",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "61f2d056-43cb-498f-9955-c762d7a4c1e5",
              "name": "- `bad_limit`: `limit` is not a whole number from 1 to 100.\n- `bad_cursor`: `cursor` is not a `next_cursor` this list answered.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e2c814ac-a41c-4dd6-ae89-d2cae9830178",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "2201258a-d436-46c6-88af-c4347abc64bc",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "5765f8fe-43fc-4c28-961b-56e546f72bd9",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "cursor",
                      "value": "<string>"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "dc2ac970-8791-4da6-a7e9-656e35382893",
          "name": "Get an incoming payout",
          "request": {
            "name": "Get an incoming payout",
            "description": {
              "content": "One Payout another Customer sent this Customer, as `GET /v1/incoming-payouts` lists it: who sent it, what arrives, the purpose the sender declared, where it stands and, once delivered, whether it was credited to the Customer's balance or paid to its bank account.\n\nRequires the `customer:read` permission. A Platform may call it for one of its End Customers with `Apex-End-Customer`.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "incoming-payouts",
                ":id"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The Payout's id."
                }
              ]
            },
            "header": [
              {
                "disabled": true,
                "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                "key": "Apex-End-Customer",
                "value": "<uuid>"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "efc736a2-f520-42be-8ee8-e1887da5f655",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"account_hint\": \"4321\",\n  \"amount\": {\n    \"amount\": \"277664.5\",\n    \"asset\": \"PKR\"\n  },\n  \"created_at\": \"2026-11-12T09:30:02Z\",\n  \"delivered_at\": \"2026-11-12T09:41:17Z\",\n  \"delivered_to\": \"bank_account\",\n  \"id\": \"0e1f2a3b-4c5d-4e6f-8a7b-9c0d1e2f3a4b\",\n  \"purpose\": \"services\",\n  \"sender_name\": \"Tom Becker\",\n  \"status\": \"delivered\",\n  \"updated_at\": \"2026-11-12T09:41:17Z\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "ce0b750c-f2bb-45b9-843d-866a77b9f150",
              "name": "- `invalid_id`: `id` is not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "5c216bfe-170f-473a-8062-cbedb99f3f74",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "9f1a7f62-9725-4899-82d0-15c4f25c9104",
              "name": "- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "43406325-134f-41a5-b38e-3a8a21610140",
              "name": "- `payout_not_found`: No Payout sent to this Customer has this id, or it is not visible yet.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "48b52927-ef49-4b39-b354-2818f2c20889",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "711f12d4-1ed7-4d63-a70b-3fb7d6e2d222",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7d2f225a-f629-47d0-b2ea-933453002fed",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "incoming-payouts",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The Payout's id."
                    }
                  ]
                },
                "header": [
                  {
                    "disabled": true,
                    "description": "A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers `end_customer_not_found`.",
                    "key": "Apex-End-Customer",
                    "value": "<uuid>"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "615e0dea-ee00-43d8-aa4c-dbda91f237ea",
      "name": "Webhooks",
      "description": {
        "content": "Endpoints that receive signed notifications of the Customer's Payouts, Deposits and Beneficiaries, and their deliveries.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "0f98af37-5e5d-47ad-a98a-dbb57bad6e85",
          "name": "List webhook endpoints",
          "request": {
            "name": "List webhook endpoints",
            "description": {
              "content": "The Customer's webhook endpoints, newest first, with the event types each receives, whether it is `active` or `disabled` (and why), its last successful delivery and since when it has been failing. Signing secrets are never shown again after registration or rotation.\n\nRequires the `customer:webhooks:manage` permission. Not available for an End Customer: `Apex-End-Customer` is refused.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "webhooks"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "a7bbd397-c394-4d66-8ba7-7214c4020653",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "[\n  {\n    \"created_at\": \"2026-11-01T12:00:00Z\",\n    \"events\": [\n      \"payout.updated\",\n      \"deposit.received\"\n    ],\n    \"failing_since\": \"1954-12-03T23:06:16.640Z\",\n    \"id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n    \"last_success_at\": \"2026-11-12T09:31:06Z\",\n    \"status\": \"active\",\n    \"updated_at\": \"2026-11-01T12:00:00Z\",\n    \"url\": \"https://hooks.example.com/apex\",\n    \"disabled_reason\": \"no successful delivery for 24 hours\"\n  },\n  {\n    \"created_at\": \"2026-11-01T12:00:00Z\",\n    \"events\": [\n      \"payout.updated\",\n      \"deposit.received\"\n    ],\n    \"failing_since\": \"1966-12-16T09:09:05.175Z\",\n    \"id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n    \"last_success_at\": \"2026-11-12T09:31:06Z\",\n    \"status\": \"active\",\n    \"updated_at\": \"2026-11-01T12:00:00Z\",\n    \"url\": \"https://hooks.example.com/apex\",\n    \"disabled_reason\": \"no successful delivery for 24 hours\"\n  }\n]",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "a52b56ba-acf0-4872-8185-4fc58870068e",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "bcfb3d91-6455-4b13-ba0a-b02565aa683e",
              "name": "- `forbidden`: The API key does not hold the `customer:webhooks:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `not_for_end_customers`: The request named an End Customer in `Apex-End-Customer`: webhook endpoints belong to the Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6867e86d-1a88-4f0f-a4f4-f94c24febefa",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "bf5063a2-60c8-4d7a-b564-650f52cd865f",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "12089e85-6b87-40e1-a5be-3bd8c7741197",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e8e5b28d-589d-43e2-8f4a-2997df7ac8a9",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "26332ca9-92db-496f-a07a-e17f1a3b9b3e",
          "name": "Register a webhook endpoint",
          "request": {
            "name": "Register a webhook endpoint",
            "description": {
              "content": "Registers an HTTPS URL to receive the Customer's events of the types named in `events` (see the webhooks of this reference for each payload). The answer carries the endpoint's signing secret, `whsec_…`, in `secret`: it is shown here only, so store it to verify `Apex-Signature` on every delivery. The URL must be `https` and resolve only to public addresses. A Customer holds at most 10 endpoints, disabled ones included. A Platform's endpoints also receive its End Customers' events, marked with `end_customer_id`.\n\nRequires the `customer:webhooks:manage` permission. Not available for an End Customer: `Apex-End-Customer` is refused.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "webhooks"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"events\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "2e525f7a-cf7e-4f21-90b5-db83fda89b66",
              "name": "Created",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"endpoint\": {\n    \"created_at\": \"2026-11-01T12:00:00Z\",\n    \"events\": [\n      \"payout.updated\",\n      \"deposit.received\"\n    ],\n    \"failing_since\": \"1991-08-03T12:10:26.720Z\",\n    \"id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n    \"last_success_at\": \"2026-11-12T09:31:06Z\",\n    \"status\": \"active\",\n    \"updated_at\": \"2026-11-01T12:00:00Z\",\n    \"url\": \"https://hooks.example.com/apex\",\n    \"disabled_reason\": \"no successful delivery for 24 hours\"\n  },\n  \"secret\": \"whsec_9fJx2Lq7Rk4mTz8vNc3bWs6yHd1gPa5e\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c03b0d18-4a8d-4d59-b364-b8675ca4fd57",
              "name": "- `bad_request`: The body is not valid JSON.\n- `validation_failed`: `url` is missing or longer than 2048 characters, or `events` is empty, has more than three entries or an empty one.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "11db6384-a73f-43c2-927c-324801c27e0b",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "48828de7-7c3c-4473-8e88-acf675dd48aa",
              "name": "- `forbidden`: The API key does not hold the `customer:webhooks:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.\n- `not_for_end_customers`: The request named an End Customer in `Apex-End-Customer`: webhook endpoints belong to the Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8c65517c-4a75-4ca6-85fd-27a6a7307d17",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e57d1272-94ae-4bfa-8e63-13231aa81bb0",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "931b55db-88d4-474d-b970-d6e5316091ea",
              "name": "- `webhook_event_unknown`: An entry of `events` is not an event type.\n- `webhook_url_invalid`: `url` is not an absolute https URL, carries a user name or password, does not resolve, or resolves to a private or reserved address.\n- `webhook_endpoint_limit`: The Customer already has 10 endpoints.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "0889dcbe-8c3f-4340-91d2-ad6bb0f36116",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b56ebdc2-4973-4cc6-9179-c49b30a0c3f1",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e8212efa-65b8-4d9f-bf7e-4c87aca94b41",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f0c1c926-4890-4855-a2a3-bb9ecef0f337",
              "name": "- `webhooks_unavailable`: The signing secret could not be made for a moment; retry.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"url\": \"https://hooks.example.com/apex\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Service Unavailable",
              "code": 503,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "65e1ebc8-904f-4c5c-a912-b67107f36f17",
          "name": "Redeliver a webhook event",
          "request": {
            "name": "Redeliver a webhook event",
            "description": {
              "content": "Sends a `delivered` or `failed` delivery again, from a first attempt, with the same event `id`, so a receiver that deduplicates on it acts once. The endpoint must be active.\n\nRequires the `customer:webhooks:manage` permission. Not available for an End Customer: `Apex-End-Customer` is refused.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "webhooks",
                "deliveries",
                ":id",
                "redeliver"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The delivery's id."
                }
              ]
            },
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST"
          },
          "response": [
            {
              "id": "fb47bbee-4c31-4cf4-8fd5-067b645acc19",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    "deliveries",
                    ":id",
                    "redeliver"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The delivery's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"attempt\": 1,\n  \"created_at\": \"2026-11-12T09:31:05Z\",\n  \"delivered_at\": \"2026-11-12T09:31:06Z\",\n  \"duration_ms\": 142,\n  \"event_id\": \"9b2f7c1e-5d4a-5e8b-a3c6-0f1d2e3a4b5c\",\n  \"event_type\": \"payout.updated\",\n  \"id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\n  \"next_attempt_at\": \"2021-06-25T22:16:15.319Z\",\n  \"payload\": {},\n  \"response_status\": 200,\n  \"state\": \"delivered\",\n  \"last_error\": \"string\",\n  \"response_body\": \"ok\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d2363517-afe5-4949-9999-08b51112dd8b",
              "name": "- `invalid_id`: `id` is not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    "deliveries",
                    ":id",
                    "redeliver"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The delivery's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b2471fb6-07b5-4cd0-bb7f-a42d326c44f5",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    "deliveries",
                    ":id",
                    "redeliver"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The delivery's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "0e85e70d-6ca2-4a66-93eb-6f78b6bd282c",
              "name": "- `forbidden`: The API key does not hold the `customer:webhooks:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.\n- `not_for_end_customers`: The request named an End Customer in `Apex-End-Customer`: webhook endpoints belong to the Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    "deliveries",
                    ":id",
                    "redeliver"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The delivery's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "377d3fa0-df82-4d93-aac4-b0734e81c434",
              "name": "- `webhook_delivery_not_found`: No delivery to an endpoint of this Customer has this id.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    "deliveries",
                    ":id",
                    "redeliver"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The delivery's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "76a54cc0-7bdc-4be7-ac5b-778c67e3fa78",
              "name": "- `webhook_endpoint_state`: The delivery's endpoint is disabled; enable it first.\n- `webhook_delivery_pending`: The delivery is still being attempted.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    "deliveries",
                    ":id",
                    "redeliver"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The delivery's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "30945203-ae4b-48b6-a606-287ea3697c40",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    "deliveries",
                    ":id",
                    "redeliver"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The delivery's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8b94594f-cdaa-4767-8c89-d77d65902441",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    "deliveries",
                    ":id",
                    "redeliver"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The delivery's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "829b3df6-7dca-4833-b7c0-0462b12612a7",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    "deliveries",
                    ":id",
                    "redeliver"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The delivery's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "c8075c0e-c5b6-49b3-a1c7-46b9dfb69a67",
          "name": "List an endpoint's deliveries",
          "request": {
            "name": "List an endpoint's deliveries",
            "description": {
              "content": "The endpoint's deliveries, newest first: each event sent to it, its `state` (`pending` while attempts remain, `delivered` once one got a 2xx, `failed` after the last), how many attempts were made, the status, start of the body and duration of the last answer, and the exact payload sent.\n\nRequires the `customer:webhooks:manage` permission. Not available for an End Customer: `Apex-End-Customer` is refused.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "webhooks",
                ":id",
                "deliveries"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [
                {
                  "disabled": true,
                  "key": "limit",
                  "value": "50",
                  "description": "How many deliveries to answer."
                }
              ],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The endpoint's id."
                }
              ]
            },
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "4f8438cd-daca-4d15-ab1f-efd53271d2d6",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "deliveries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    }
                  ],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "[\n  {\n    \"attempt\": 1,\n    \"created_at\": \"2026-11-12T09:31:05Z\",\n    \"delivered_at\": \"2026-11-12T09:31:06Z\",\n    \"duration_ms\": 142,\n    \"event_id\": \"9b2f7c1e-5d4a-5e8b-a3c6-0f1d2e3a4b5c\",\n    \"event_type\": \"payout.updated\",\n    \"id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\n    \"next_attempt_at\": \"1949-08-27T21:16:56.288Z\",\n    \"payload\": {},\n    \"response_status\": 200,\n    \"state\": \"delivered\",\n    \"last_error\": \"string\",\n    \"response_body\": \"ok\"\n  },\n  {\n    \"attempt\": 1,\n    \"created_at\": \"2026-11-12T09:31:05Z\",\n    \"delivered_at\": \"2026-11-12T09:31:06Z\",\n    \"duration_ms\": 142,\n    \"event_id\": \"9b2f7c1e-5d4a-5e8b-a3c6-0f1d2e3a4b5c\",\n    \"event_type\": \"payout.updated\",\n    \"id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\n    \"next_attempt_at\": \"1991-10-03T14:25:21.315Z\",\n    \"payload\": {},\n    \"response_status\": 200,\n    \"state\": \"delivered\",\n    \"last_error\": \"string\",\n    \"response_body\": \"ok\"\n  }\n]",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "08c37128-9b51-409c-adc8-3d2eeb57b466",
              "name": "- `invalid_id`: `id` is not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "deliveries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    }
                  ],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "87632b4e-096e-481b-9ccb-4c57b69f1b3e",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "deliveries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    }
                  ],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "71ac4a66-eada-44af-bb6b-861fc146d1cf",
              "name": "- `forbidden`: The API key does not hold the `customer:webhooks:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `not_for_end_customers`: The request named an End Customer in `Apex-End-Customer`: webhook endpoints belong to the Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "deliveries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    }
                  ],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b32d6af2-e082-4c13-b54a-ea407ce61f46",
              "name": "- `webhook_endpoint_not_found`: No endpoint of this Customer has this id.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "deliveries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    }
                  ],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "4ea00b59-cd12-43c4-af66-a20d9f748064",
              "name": "- `bad_limit`: `limit` is not a whole number from 1 to 100.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "deliveries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    }
                  ],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f7c213e5-723d-4a99-8fbf-206bf8f135b1",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "deliveries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    }
                  ],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e359d942-3aa9-430f-b2c5-ae5209749586",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "deliveries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    }
                  ],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "4f3214ec-928c-4d94-8768-0a94fc6793da",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "deliveries"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "limit",
                      "value": "50"
                    }
                  ],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "3feecd48-6638-47b4-bd1a-020ea7d76c68",
          "name": "Disable a webhook endpoint",
          "request": {
            "name": "Disable a webhook endpoint",
            "description": {
              "content": "Stops sending to the endpoint: new events are no longer queued for it, and a delivery still pending fails at its next attempt (redeliver it once the endpoint is enabled again). Enable it again with `POST /v1/webhooks/{id}/enable`. Allowed while the Customer is suspended.\n\nRequires the `customer:webhooks:manage` permission. Not available for an End Customer: `Apex-End-Customer` is refused.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "webhooks",
                ":id",
                "disable"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The endpoint's id."
                }
              ]
            },
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST"
          },
          "response": [
            {
              "id": "fba28aad-79c2-49e1-bd29-7dc43e6a8c7d",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "disable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"created_at\": \"2026-11-01T12:00:00Z\",\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"failing_since\": \"1964-10-16T11:34:59.063Z\",\n  \"id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n  \"last_success_at\": \"2026-11-12T09:31:06Z\",\n  \"status\": \"active\",\n  \"updated_at\": \"2026-11-01T12:00:00Z\",\n  \"url\": \"https://hooks.example.com/apex\",\n  \"disabled_reason\": \"no successful delivery for 24 hours\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "49b7bbdd-348b-4a15-a321-fb31065fa078",
              "name": "- `invalid_id`: `id` is not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "disable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1f3117f6-ba5a-4546-8f72-c15a822b30c4",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "disable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d1df56b4-d256-408b-a925-ac569055de0f",
              "name": "- `forbidden`: The API key does not hold the `customer:webhooks:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `not_for_end_customers`: The request named an End Customer in `Apex-End-Customer`: webhook endpoints belong to the Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "disable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8dce115b-33c4-4100-8a0e-46da938999cb",
              "name": "- `webhook_endpoint_not_found`: No endpoint of this Customer has this id.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "disable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "4c87e059-624b-41b3-98f4-632f28135c8c",
              "name": "- `webhook_endpoint_state`: The endpoint is already disabled.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "disable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "d18eb4c6-6c70-448a-be81-8e2605b44d34",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "disable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8ef56e2e-1337-438a-8d2b-f1c6e78ac9e8",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "disable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b3f87056-41c3-4aef-82e4-a1433828d030",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "disable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "52671133-49e0-44fc-8321-ea23dd18911c",
          "name": "Enable a webhook endpoint",
          "request": {
            "name": "Enable a webhook endpoint",
            "description": {
              "content": "Sends to a disabled endpoint again, whether you disabled it or it was disabled after failing for 24 hours; the failure clock starts afresh. Deliveries that failed while it was off stay failed until redelivered with `POST /v1/webhooks/deliveries/{id}/redeliver`.\n\nRequires the `customer:webhooks:manage` permission. Not available for an End Customer: `Apex-End-Customer` is refused.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "webhooks",
                ":id",
                "enable"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The endpoint's id."
                }
              ]
            },
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST"
          },
          "response": [
            {
              "id": "ae4ae82d-64c6-41ca-8ab4-5ea30d4a6990",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "enable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"created_at\": \"2026-11-01T12:00:00Z\",\n  \"events\": [\n    \"payout.updated\",\n    \"deposit.received\"\n  ],\n  \"failing_since\": \"1964-10-16T11:34:59.063Z\",\n  \"id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n  \"last_success_at\": \"2026-11-12T09:31:06Z\",\n  \"status\": \"active\",\n  \"updated_at\": \"2026-11-01T12:00:00Z\",\n  \"url\": \"https://hooks.example.com/apex\",\n  \"disabled_reason\": \"no successful delivery for 24 hours\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f59b6297-9bb3-46fb-bfce-63cd2a2876dc",
              "name": "- `invalid_id`: `id` is not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "enable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "cf1d5c31-babc-42eb-bb86-f40bd36a9a44",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "enable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1db2ae66-058f-4a3e-93ba-1052eb51cca1",
              "name": "- `forbidden`: The API key does not hold the `customer:webhooks:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.\n- `not_for_end_customers`: The request named an End Customer in `Apex-End-Customer`: webhook endpoints belong to the Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "enable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "979ca3e3-e7e2-4f84-94d2-72c6fe7e4d71",
              "name": "- `webhook_endpoint_not_found`: No endpoint of this Customer has this id.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "enable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "2ae282e0-057a-4281-b097-8bb54723f3bf",
              "name": "- `webhook_endpoint_state`: The endpoint is already active.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "enable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "fd0e62ef-5539-4489-878b-365a04fd5c96",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "enable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "9ff1667b-163a-4518-9fdf-301e4d448325",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "enable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "433873d5-3f53-4eea-acb8-46ed31876f42",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "enable"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "f09de30d-a56e-44e9-b988-2a6cc5bf0bcb",
          "name": "Rotate a webhook endpoint's signing secret",
          "request": {
            "name": "Rotate a webhook endpoint's signing secret",
            "description": {
              "content": "Replaces the endpoint's signing secret at once: every attempt from now on, retries of older deliveries included, is signed with the new one. The answer carries the new `whsec_…` secret, shown here only.\n\nRequires the `customer:webhooks:manage` permission. Not available for an End Customer: `Apex-End-Customer` is refused.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "webhooks",
                ":id",
                "rotate-secret"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The endpoint's id."
                }
              ]
            },
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST"
          },
          "response": [
            {
              "id": "54e442a1-f403-4e7b-97cd-66ff749eab93",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "rotate-secret"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"endpoint\": {\n    \"created_at\": \"2026-11-01T12:00:00Z\",\n    \"events\": [\n      \"payout.updated\",\n      \"deposit.received\"\n    ],\n    \"failing_since\": \"1991-08-03T12:10:26.720Z\",\n    \"id\": \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\",\n    \"last_success_at\": \"2026-11-12T09:31:06Z\",\n    \"status\": \"active\",\n    \"updated_at\": \"2026-11-01T12:00:00Z\",\n    \"url\": \"https://hooks.example.com/apex\",\n    \"disabled_reason\": \"no successful delivery for 24 hours\"\n  },\n  \"secret\": \"whsec_9fJx2Lq7Rk4mTz8vNc3bWs6yHd1gPa5e\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7f4e2ec8-e4f5-4c69-b74e-ab4dc80732b9",
              "name": "- `invalid_id`: `id` is not a UUID.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "rotate-secret"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "916e802c-2685-41a8-9fba-e06876cc230d",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "rotate-secret"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7dabd4fe-fd9f-4480-8121-2c014435dcdc",
              "name": "- `forbidden`: The API key does not hold the `customer:webhooks:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.\n- `not_for_end_customers`: The request named an End Customer in `Apex-End-Customer`: webhook endpoints belong to the Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "rotate-secret"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "208ffcac-7d75-4533-a10a-30cbc4f8af7f",
              "name": "- `webhook_endpoint_not_found`: No endpoint of this Customer has this id.\n- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "rotate-secret"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "49f8b186-ef13-4e7c-8d4e-c184873b1165",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "rotate-secret"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "27f59a74-fff7-47ca-8b3e-b749b6681397",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "rotate-secret"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8364558f-4805-4e32-9ca9-90ced4b36b04",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "rotate-secret"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "5d0c53f3-de59-46d6-b4b3-b83896ee39ba",
              "name": "- `webhooks_unavailable`: The signing secret could not be made for a moment; retry.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "webhooks",
                    ":id",
                    "rotate-secret"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The endpoint's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Service Unavailable",
              "code": 503,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    },
    {
      "id": "4e77cb5d-e2b4-4b43-9020-5d1c61f33b37",
      "name": "End customers",
      "description": {
        "content": "The Platform API: a Platform opens and manages its End Customers, and acts for one on the other operations with the `Apex-End-Customer` header.",
        "type": "text/plain"
      },
      "item": [
        {
          "id": "f2c47f50-d72a-4445-bcf5-a81a4d4c990a",
          "name": "List End Customers",
          "request": {
            "name": "List End Customers",
            "description": {
              "content": "The Platform's End Customers, newest first, with each one's onboarding `state` and `standing`.\n\nRequires the `customer:read` permission.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "end-customers"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [
                {
                  "disabled": true,
                  "key": "state",
                  "value": "<string>",
                  "description": "Only End Customers in this state."
                },
                {
                  "disabled": true,
                  "key": "q",
                  "value": "<string>",
                  "description": "Only End Customers whose legal name or email contains this text."
                },
                {
                  "disabled": true,
                  "key": "limit",
                  "value": "50",
                  "description": "How many End Customers to answer."
                },
                {
                  "disabled": true,
                  "key": "offset",
                  "value": "0",
                  "description": "How many to skip, for the next page."
                }
              ],
              "variable": []
            },
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "df909113-ef73-43ee-912f-69c096ecd0d9",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "q",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "offset",
                      "value": "0"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "[\n  {\n    \"country\": \"PK\",\n    \"created_at\": \"2026-11-10T14:05:00Z\",\n    \"email\": \"lina@example.com\",\n    \"id\": \"3f6c2a9e-8b1d-4c7a-9e2f-5a6b7c8d9e0f\",\n    \"legal_name\": \"Lina Qureshi\",\n    \"providers\": [\n      {\n        \"provider\": \"bvnk\",\n        \"state\": \"approved\"\n      }\n    ],\n    \"standing\": \"active\",\n    \"state\": \"active\",\n    \"type\": \"individual\",\n    \"updated_at\": \"2026-11-11T10:20:00Z\",\n    \"has_people\": false,\n    \"suspended_by\": \"platform\",\n    \"suspended_reason\": \"string\"\n  },\n  {\n    \"country\": \"PK\",\n    \"created_at\": \"2026-11-10T14:05:00Z\",\n    \"email\": \"lina@example.com\",\n    \"id\": \"3f6c2a9e-8b1d-4c7a-9e2f-5a6b7c8d9e0f\",\n    \"legal_name\": \"Lina Qureshi\",\n    \"providers\": [\n      {\n        \"provider\": \"bvnk\",\n        \"state\": \"approved\"\n      }\n    ],\n    \"standing\": \"active\",\n    \"state\": \"active\",\n    \"type\": \"individual\",\n    \"updated_at\": \"2026-11-11T10:20:00Z\",\n    \"has_people\": false,\n    \"suspended_by\": \"platform\",\n    \"suspended_reason\": \"string\"\n  }\n]",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "45b8d73d-6c56-4457-a88b-46929198f60b",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "q",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "offset",
                      "value": "0"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f8406bb3-153a-4ba7-b3d6-60568f129cfa",
              "name": "- `not_a_platform`: The Customer is not a Platform, or the request named an End Customer in `Apex-End-Customer`.\n- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "q",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "offset",
                      "value": "0"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "e7fad475-7c02-4e65-b5b8-8a2cf950e14d",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "q",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "offset",
                      "value": "0"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "ee183610-4703-4365-b552-f08cf74b6abf",
              "name": "- `bad_limit`: `limit` is not a positive whole number or `offset` a non-negative one.\n- `unknown_state`: `state` is not one of the states.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "q",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "offset",
                      "value": "0"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "ce97dfc9-6e97-45d2-8c20-9bc6d58191ff",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "q",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "offset",
                      "value": "0"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "618a40b7-7536-4120-87b1-c0ab6893e692",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "q",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "offset",
                      "value": "0"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "bff4fa99-aa46-4eef-aedd-2ef7dbebc570",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [
                    {
                      "key": "state",
                      "value": "<string>"
                    },
                    {
                      "key": "q",
                      "value": "<string>"
                    },
                    {
                      "key": "limit",
                      "value": "50"
                    },
                    {
                      "key": "offset",
                      "value": "0"
                    }
                  ],
                  "variable": []
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "a9741442-8fa0-42f1-8eb0-e545fb99c0ea",
          "name": "Open an End Customer",
          "request": {
            "name": "Open an End Customer",
            "description": {
              "content": "Opens an End Customer of the Platform in `profile_pending`. The Platform then passes its onboarding for it through the Onboarding operations with `Apex-End-Customer` set to its `id`; once it is approved it is submitted to the Providers that approved the Platform. Alternatively `invite_email` invites its first person to do that in the Customer panel; only a person of the Platform can invite, so an API key sending `invite_email` is refused with `people_only`. `country` must be one the platform serves.\n\nRequires the `customer:end_customers:manage` permission. Send an `Idempotency-Key`: a retry with the same key and body answers the first response again (marked `Idempotency-Replayed: true`) for 24 hours.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "end-customers"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": []
            },
            "header": [
              {
                "disabled": false,
                "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                "key": "Idempotency-Key",
                "value": "<string>"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"country\": \"<string>\",\n  \"email\": \"<string>\",\n  \"legal_name\": \"<string>\",\n  \"type\": \"<string>\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"<string>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "d7e36f9e-7579-409c-8824-42b6107b1608",
              "name": "Created",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Created",
              "code": 201,
              "header": [
                {
                  "disabled": true,
                  "description": "`true` when this answer is the stored response to an earlier request with the same `Idempotency-Key`.",
                  "key": "Idempotency-Replayed",
                  "value": "true"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"country\": \"PK\",\n  \"created_at\": \"2026-11-10T14:05:00Z\",\n  \"email\": \"lina@example.com\",\n  \"id\": \"3f6c2a9e-8b1d-4c7a-9e2f-5a6b7c8d9e0f\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"providers\": [\n    {\n      \"provider\": \"bvnk\",\n      \"state\": \"approved\"\n    }\n  ],\n  \"standing\": \"active\",\n  \"state\": \"active\",\n  \"type\": \"individual\",\n  \"updated_at\": \"2026-11-11T10:20:00Z\",\n  \"has_people\": false,\n  \"suspended_by\": \"operator\",\n  \"suspended_reason\": \"string\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1baa0fe3-ab85-4743-9b26-050ec0a76b94",
              "name": "- `bad_request`: The body is not valid JSON.\n- `validation_failed`: `type`, `legal_name`, `email` or `country` is missing or malformed, or `invite_email` or `invite_name` is malformed.\n- `idempotency_key_required`: The `Idempotency-Key` header is missing.\n- `idempotency_key_invalid`: The `Idempotency-Key` header is longer than 128 characters.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "c5477731-2b7e-4f61-94d4-12fe1b129f78",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "67f51c9e-a106-4c45-af95-c726dad1deda",
              "name": "- `people_only`: `invite_email` was sent with an API key.\n- `not_a_platform`: The Customer is not a Platform, or the request named an End Customer in `Apex-End-Customer`.\n- `forbidden`: The API key does not hold the `customer:end_customers:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8685687f-76ca-4839-b53c-d8b523b79556",
              "name": "- `end_customer_not_found`: `Apex-End-Customer` names no End Customer of the calling Platform: not a UUID, unknown, another Platform's, or the caller is not a Platform.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "a2a8ca96-dc5a-4b05-87d3-6379fc80aa59",
              "name": "- `customer_email_taken`: The Platform already has an End Customer with this email.\n- `idempotency_in_progress`: A request with the same `Idempotency-Key` is still being processed; retry in a moment.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "59ac76ec-2ccc-4ab4-afdc-fc24c4ffbe89",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "3aa77087-bd65-43de-9710-5917ee38b614",
              "name": "- `country_not_accepted`: `country` is not one the platform serves.\n- `idempotency_key_reused`: The `Idempotency-Key` was already used with a different request body.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unprocessable Entity (WebDAV) (RFC 4918)",
              "code": 422,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "9d2d6610-ab1a-4c13-b872-0886c8f05970",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6f745a0f-5681-4aff-afd5-c9e31278e29c",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "38c5c054-e4e3-469f-b1af-79340ab31dc0",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": []
                },
                "header": [
                  {
                    "disabled": false,
                    "description": "(Required) A unique key per intended request, such as a UUID. A retry with the same key and body answers the first response again for 24 hours instead of acting twice; the same key with another body is `idempotency_key_reused`. An error answer is not kept, so a request that failed may be retried under its key.",
                    "key": "Idempotency-Key",
                    "value": "5f1c2b9e-6a1d-4c3e-9b7a-2d8e4f6a1c03"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"country\": \"PK\",\n  \"email\": \"lina@example.com\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"type\": \"individual\",\n  \"invite_email\": \"<string>\",\n  \"invite_name\": \"Lina Qureshi\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "a4826ab1-a50a-4fab-b5f9-f02d155a25de",
          "name": "Get an End Customer",
          "request": {
            "name": "Get an End Customer",
            "description": {
              "content": "One of the Platform's End Customers, with each Provider's decision on it and `has_people`, whether anyone can sign in for it yet.\n\nRequires the `customer:read` permission.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "end-customers",
                ":id"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The End Customer's id."
                }
              ]
            },
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "GET"
          },
          "response": [
            {
              "id": "a2d045ac-307e-46f6-a642-d452a3fde708",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"country\": \"PK\",\n  \"created_at\": \"2026-11-10T14:05:00Z\",\n  \"email\": \"lina@example.com\",\n  \"id\": \"3f6c2a9e-8b1d-4c7a-9e2f-5a6b7c8d9e0f\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"providers\": [\n    {\n      \"provider\": \"bvnk\",\n      \"state\": \"approved\"\n    }\n  ],\n  \"standing\": \"active\",\n  \"state\": \"active\",\n  \"type\": \"individual\",\n  \"updated_at\": \"2026-11-11T10:20:00Z\",\n  \"has_people\": false,\n  \"suspended_by\": \"operator\",\n  \"suspended_reason\": \"string\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "43fff2ff-b02c-4447-868d-4ba66a942551",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "dc6eb22f-82fc-40d2-834c-d77f5130eec8",
              "name": "- `not_a_platform`: The Customer is not a Platform, or the request named an End Customer in `Apex-End-Customer`.\n- `forbidden`: The API key does not hold the `customer:read` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "8b55f3ba-d5f0-496c-b7bc-3e904bc7bcfa",
              "name": "- `end_customer_not_found`: No End Customer of this Platform has this id.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "f48a316a-2795-4bd6-bbcf-af1f03561021",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "cc2f013b-04d6-41a9-a636-4c66475a0062",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "eee7613a-09a6-410e-b087-a2551b42b779",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "GET",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "4f74e4fd-bbbd-48b5-97da-b41e921f3f80",
          "name": "Reactivate an End Customer",
          "request": {
            "name": "Reactivate an End Customer",
            "description": {
              "content": "Lifts a suspension the Platform made. A suspension by the operations team stands and only they can lift it.\n\nRequires the `customer:end_customers:manage` permission.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "end-customers",
                ":id",
                "reactivate"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The End Customer's id."
                }
              ]
            },
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST"
          },
          "response": [
            {
              "id": "207ed45d-bfc4-4f11-b43f-8bfbeef3b256",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "reactivate"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"country\": \"PK\",\n  \"created_at\": \"2026-11-10T14:05:00Z\",\n  \"email\": \"lina@example.com\",\n  \"id\": \"3f6c2a9e-8b1d-4c7a-9e2f-5a6b7c8d9e0f\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"providers\": [\n    {\n      \"provider\": \"bvnk\",\n      \"state\": \"approved\"\n    }\n  ],\n  \"standing\": \"active\",\n  \"state\": \"active\",\n  \"type\": \"individual\",\n  \"updated_at\": \"2026-11-11T10:20:00Z\",\n  \"has_people\": false,\n  \"suspended_by\": \"operator\",\n  \"suspended_reason\": \"string\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "18e5e948-08cd-4175-8382-170830d4ea45",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "reactivate"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "3de6687d-eaac-4806-83ac-19595fbfa76b",
              "name": "- `not_a_platform`: The Customer is not a Platform, or the request named an End Customer in `Apex-End-Customer`.\n- `suspended_by_operator`: The operations team suspended this End Customer.\n- `forbidden`: The API key does not hold the `customer:end_customers:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.\n- `customer_suspended`: The Customer is suspended: it can still read, but changes nothing until it is reactivated.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "reactivate"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "6b65743d-c2ba-4758-ae94-ffb6bbd58806",
              "name": "- `end_customer_not_found`: No End Customer of this Platform has this id.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "reactivate"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "afcdfa4b-c803-475f-beb0-4c1c727ad646",
              "name": "- `invalid_transition`: The End Customer is not suspended.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "reactivate"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "1dc766f8-030b-42ad-8177-88a28d1a67ea",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "reactivate"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "3595081b-0505-405e-b530-c3fdf2732e60",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "reactivate"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "980e3b7a-ba94-48d0-9293-4b2b0aa51cd5",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "reactivate"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {}
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        },
        {
          "id": "e7b93799-9423-4a69-8c40-2b7812f10eb5",
          "name": "Suspend an End Customer",
          "request": {
            "name": "Suspend an End Customer",
            "description": {
              "content": "Suspends an active End Customer of the Platform: it can still read, but changes nothing and sends no new Payouts until reactivated; Payouts already handed to a Provider run their course. Allowed while the Platform itself is suspended.\n\nRequires the `customer:end_customers:manage` permission.",
              "type": "text/plain"
            },
            "url": {
              "path": [
                "v1",
                "end-customers",
                ":id",
                "suspend"
              ],
              "host": [
                "{{baseUrl}}"
              ],
              "query": [],
              "variable": [
                {
                  "disabled": false,
                  "type": "any",
                  "value": "<uuid>",
                  "key": "id",
                  "description": "(Required) The End Customer's id."
                }
              ]
            },
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "method": "POST",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"reason\": \"<string>\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          },
          "response": [
            {
              "id": "f266a5ff-8091-4800-bb55-18c47d244536",
              "name": "OK",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "OK",
              "code": 200,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"country\": \"PK\",\n  \"created_at\": \"2026-11-10T14:05:00Z\",\n  \"email\": \"lina@example.com\",\n  \"id\": \"3f6c2a9e-8b1d-4c7a-9e2f-5a6b7c8d9e0f\",\n  \"legal_name\": \"Lina Qureshi\",\n  \"providers\": [\n    {\n      \"provider\": \"bvnk\",\n      \"state\": \"approved\"\n    }\n  ],\n  \"standing\": \"active\",\n  \"state\": \"active\",\n  \"type\": \"individual\",\n  \"updated_at\": \"2026-11-11T10:20:00Z\",\n  \"has_people\": false,\n  \"suspended_by\": \"operator\",\n  \"suspended_reason\": \"string\"\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b81d53a9-c2a6-4b3c-90a3-416e8a0eee9c",
              "name": "- `bad_request`: The body is not valid JSON.\n- `validation_failed`: `reason` is missing or longer than 2000 characters.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Request",
              "code": 400,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "29ce39f0-20b8-4ade-96f6-8107fde1ad42",
              "name": "- `unauthorized`: No `Authorization` header, or a bearer that is not an API key.\n- `api_key_invalid`: The API key is unknown or malformed, belongs to another environment (`ak_test_` keys work only outside production, `ak_live_` keys only in it), or was sent beside a second `Authorization` header.\n- `api_key_revoked`: The API key was revoked.\n- `api_key_expired`: The API key passed its expiry date.\n- `api_key_ip_denied`: The request came from an address outside the API key's allowlist.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "0dd0cef2-e5a7-485a-8d45-3d7c079c62ef",
              "name": "- `not_a_platform`: The Customer is not a Platform, or the request named an End Customer in `Apex-End-Customer`.\n- `forbidden`: The API key does not hold the `customer:end_customers:manage` permission.\n- `customer_not_active`: The Customer is still being onboarded or was rejected; until it is active only the Onboarding operations and `GET /v1/customer` are open.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Forbidden",
              "code": 403,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "4bb31842-ab86-49ca-ad39-e1b401b190f3",
              "name": "- `end_customer_not_found`: No End Customer of this Platform has this id.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Not Found",
              "code": 404,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "b0839660-297c-44fa-a229-6abe52b2414a",
              "name": "- `invalid_transition`: The End Customer is not active.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Conflict",
              "code": 409,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "7c05b962-0702-45c8-873a-4a9a0890bf20",
              "name": "- `payload_too_large`: The request body is larger than 1 MB.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Request Entity Too Large",
              "code": 413,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "abd13f46-a97a-4792-85d3-a538d4000c3e",
              "name": "- `rate_limited`: Too many requests from this API key, or from the Customer as a whole; wait the number of seconds in `Retry-After`.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Too Many Requests",
              "code": 429,
              "header": [
                {
                  "disabled": true,
                  "description": "Seconds to wait before trying again.",
                  "key": "Retry-After",
                  "value": "4859"
                },
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "53b8a32a-2820-4398-8b21-9238f5430d7a",
              "name": "- `internal_error`: Something failed on our side. The message is always `internal error`; quote the `correlation_id` when you report it.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Internal Server Error",
              "code": 500,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            },
            {
              "id": "cb74d27d-2c75-4d4c-a76a-f4b9d8167f3c",
              "name": "- `bad_gateway`: The API could not be reached for a moment; retry later.",
              "originalRequest": {
                "url": {
                  "path": [
                    "v1",
                    "end-customers",
                    ":id",
                    "suspend"
                  ],
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "query": [],
                  "variable": [
                    {
                      "disabled": false,
                      "type": "any",
                      "value": "<uuid>",
                      "key": "id",
                      "description": "(Required) The End Customer's id."
                    }
                  ]
                },
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "method": "POST",
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"reason\": \"Documents under review by our compliance team.\"\n}",
                  "options": {
                    "raw": {
                      "language": "json"
                    }
                  }
                }
              },
              "status": "Bad Gateway",
              "code": 502,
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "body": "{\n  \"code\": \"quote_expired\",\n  \"message\": \"the quote has expired\",\n  \"correlation_id\": \"b7e2c9d4-1f3a-4e5b-8c6d-9a0f1e2d3c4b\",\n  \"details\": [\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    },\n    {\n      \"field\": \"amount\",\n      \"message\": \"failed on the 'required' rule\"\n    }\n  ]\n}",
              "cookie": [],
              "_postman_previewlanguage": "json"
            }
          ],
          "event": [],
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          }
        }
      ],
      "event": []
    }
  ],
  "event": [],
  "variable": [
    {
      "key": "baseUrl",
      "value": "http://localhost:3480",
      "type": "string"
    },
    {
      "key": "apiKey",
      "value": "ak_test_replace_me",
      "type": "string"
    }
  ],
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{apiKey}}",
        "type": "string"
      }
    ]
  },
  "info": {
    "_postman_id": "4f10c206-2a04-405c-930e-5feb386e0085",
    "name": "Apex Settlement API",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "description": "The Customer API lets your systems pass onboarding, hold balances, register Beneficiaries, quote and send cross-border Payouts, follow the Payouts other Customers send you, and receive signed webhooks.\n\nEvery request carries an API key: `Authorization: Bearer ak_live_…` (`ak_test_…` outside production). A key holds a subset of its creator's permissions; each operation names the one it needs. Amounts are decimal strings, never numbers. Every error answers `{code, message, correlation_id, details?}`: branch on `code`, show `message` only as a fallback, and quote `correlation_id` when you report a problem.\n\nA Platform acts for one of its End Customers by naming it in the `Apex-End-Customer` header; the key's own permissions still apply.\n\nSet the collection variables `baseUrl` and `apiKey` (an `ak_test_…` sandbox key) before sending requests."
  }
}