Skip to main content

Customer Management

Service Users can retrieve customer master data, including contract and personal details, addresses, contact information, and know-your-client (KYC) information. Contact information, as well as addresses, can be updated by the Service User.

The following subsections present the operations available on the Customer Management API.

Retrieve a list of customers (GET/customers)​

This request can be used to retrieve a list of all authorized customers and their respective personal details, such as addresses and persons related to their contracts. Authorized customers are defined as those that hold a contract with a Service Provider and for which consent has been granted.

A successful API response for this request will return the ID, name, and customer details, as well as a link to persons and addresses related to the customer contract.

Retrieve the full client record of a specific customer (GET/customers/{customerId})​

This request can be used to retrieve a list of one authorized customer and their respective personal details, such as addresses and persons related to the customer contracts. Authorized customers are defined as those that hold a contract with a Service Provider for which consent has been granted.

A successful API response for this request will return the ID, name, customer details, and a link to persons and addresses related to the customer contract.

Retrieve the KYC record of a specific customer (GET/customers/{customerId}/kyc)​

This request can be used to retrieve a know-your-client (KYC) record for a specific authorized customer. As a result, the user will receive the ID, name, details, and a link to persons and addresses related to a specific customer contract. In addition, the API will return KYC information about the financial and non-financial situation of the customer.

Retrieve a list of full person records (GET/persons)​

Service Users can use this request to retrieve a list of full person records. A successful API response will return a list of basic personal information of the person with the respective customer contracts, as well as the contact details.

Retrieve a full person record for a specific person (GET/persons/{personId})​

This request can be used to retrieve a full record of a person related to a specific customer. As a result, the user will receive a specific person's basic information with respective customer contracts, as well as contact details.

Retrieve contact details for a specific person id (GET/persons/{personId}/contactdetails)​

This request can be used to retrieve the contact details of a specific person based on their unique identifier. A successful API response will return a list of contact details for one particular person.

Create new contact details for a specific person (POST/persons/{personId}/contactdetails)​

Service Users can use this request to create new/additional contact details for a specific person. To create new contact details, the user must submit the contact medium, medium type, content and additional contact information. As a result, the user will receive a response about successfully creating the contact details together with the new contact detail ID.

Create a new address object for a specific customer (POST/customers/{customerId}/addresses)​

This request can be used to create a new address object for a specific customer. The user must submit address details in a structured format. As a result, the user will receive a response about the successful creation of the new address object together with the new address ID.

Retrieve an address record for a specific address id (GET/customer/{customerId}/addresses)​

This request can be used to retrieve an address record of a specific customer. As a result, the user will receive a specific address object in a structured format.

Update an existing address object for a specific customer (PUT/customer/{customerId}/addresses)​

Service Users can use this request to update an existing address object for a specific customer. The user must submit the unique identifier of the address that will be updated, as well as the updated address details.

Health check of the Customer Management Module (/healthcheck)​

This request can be used to check if a specific module of the selected Service Provider is available. An empty request will be sent over bLink to the corresponding Service Provider and return a timestamp and confirmation about receipt.

Last updated on