Customer, partner and supporting APIs

These routes require bearer authentication and access to the requested customer, partner, application or loan.

Look up customers and reference data

Use get-customer-by-id when you already have a customer ID. For email lookup, URL-encode the email query value. Customer lookup success schemas are currently untyped in Swagger; do not assume a generated object sample describes all returned fields.

Use get-industries for available industry reference data. The first-request tutorial demonstrates that read.

Read and send application messages

Get-all-messages accepts skip and take, capped at 200. To send a message, use post-messages with:

{
  "contents": "A supporting document is ready for review.",
  "user": "API"
}

contents is required and user must be non-empty and at most 30 characters. The current handler returns true even though Swagger omits its success-body schema.

Read partner records

Partner routes provide applications, agents, loans and advances. Application filters distinguish creation-date queries from last-updated queries. Use the parameters of the selected route; do not assume all partner lists accept paging. The deleted option is available on the agents route.

Invoice customers

Read invoice customers for a loan, then use request-enable with invoiceCustomerId in the query when an enablement request is intended. The current handler returns true on success, but Swagger does not declare that body.

Invoice-customer lookup returns one InvoiceCustomer object with data and totalCount, despite Swagger declaring InvoiceCustomer[]. It returns 400 when there are no results. Supply explicit skip and take values; this API forwards them without the loan/communication 200-record cap.

Test routes

The full reference also includes quick-test and a webhook test receiver. Quick-test stores banking data and publishes a processing event; use it only with a test application. These utilities are not required steps in a normal customer workflow. Hidden operational routes are not part of the published integration contract.

Endpoint reference