Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
Customers

Get customer details

Once the workflow status returns as COMPLETED, it is possible to collect the latest customer record.

The response contains all the information submitted during the POST /v2/customer request.

The customer-identifier can be found within the GET /v2/workflows/ response from within the step_output within the customer-creation step.

There is a number of customer statuses that can be returned from this endpoint:

Status nameDescription
ProcessingThe customer has been created successfully but there are parts of the create-and-screen workflow that are still in progress
ActiveThe customer is active - the initial risk level is not prohibited and there are no onboarding screening results, or these results were returned and their case status is accepted
ClosedThe customer is closed - the initial risk level is prohibited, or there are screening results and the case status is rejected, or maybe the client closed this customer for another reason.

You need the "View customers" permission to use this endpoint.

get/v2/customers/{customer_identifier}

Path parameters

customer_identifierstring uuid required

The unique identifier we provided when you created the customer.

Response

Get a customer.

acquisition_sourcestring nullable
created_atstring date-time required
customer_identifierstring uuid required
external_identifierstring required
status'ACTIVE' | 'CLOSED' | 'PROCESSING' required
updated_atstring date-time required
versioninteger required

Example response

{
  "company": {
    "custom_fields": [
      {
        "key": "field_key",
        "value": {
          "date": "2022-09-27T00:00:00.000Z"
        }
      }
    ]
  },
  "person": {
    "custom_fields": [
      {
        "key": "field_key",
        "value": {
          "date": "2022-09-27T00:00:00.000Z"
        }
      }
    ]
  },
  "undefined": {
    "custom_fields": [
      {
        "key": "field_key",
        "value": {
          "date": "2022-09-27T00:00:00.000Z"
        }
      }
    ]
  }
}