Get Customer
Read the customer back after any step that enriches it — a registry lookup or a document extraction — rather than trusting your local copy.
Authorizations
Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.
Headers
Your tenant identifier. Requests without it are rejected.
Path Parameters
The customer id
^customer(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Query Parameters
Optional: the whenAt datetime
Optional: the simulatedAt datetime
Optional: the branchId
^branch(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Response
Type of the customer
Unique identifier for the customer
^customer(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Date and time when the customer was created
Date and time when the customer was last modified
Status of the customer
CUSTOMER_CREATED, CUSTOMER_CONFIRMED Policies associated with the customer
^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Customer business role
DIRECT_DEBIT, BANK_TRANSFER custom fields per product
Optional: Name of the entity
Optional: Preferred payment method of the customer
^payment_method(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
