Skip to main content
GET
Get customer by reference id

Authorizations

Authorization
string
header
required

Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}. API keys are issued and revoked directly from the creditor portal under Developers > API.

Path Parameters

tenantId
string<uuid>
required

Id of your debt collection partner's tenant. You can find it on the API page in the creditor portal.

referenceId
string
required

Your reference id for the customer. Typically the customer number from your own system.

Query Parameters

creditorId
string<uuid>
required

Your creditor id. You can find it on the API page in the creditor portal.

Response

Successful operation

creditorId
string<uuid>

Id of creditor

createdAt
string

Customer created at

customerId
string<uuid>

Id of the customer

tenantId
string<uuid>

Id of the tenant

referenceId
string

Reference id of the customer. Typically id of the customer, client, patient or similar.

isCompany
boolean

Whether the customer is a company.

users
object[]

List of users related to this customer

cases
object[]

List of cases related to this customer