API ReferenceCustomersAPI IntegrationThird Parties

Get Third-Party Customer

Beta

This endpoint allows authorized partner platforms to retrieve the complete profile of a third-party customer using their unique reference identifier. It returns a detailed dataset including personal and contact information, residential address, employment details, property details, and the customer’s current compliance status.

Authentication: Bearer token required

Path parameters

customer_idstringRequired

Unique identifier of the partner platform retrieving the third-party customer.

client_customer_refstringRequired

Partner’s internal reference/ID for this customer. Must be alphanumeric and may include underscores (_) and hyphens (-). This is the customer reference that was provided during customer creation via Create Partner Customer.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Third-party customer details retrieved successfully

client_customer_detailsobject
statusenum

Status of the third party customer.

  • APPROVED: Compliance check has passed successfully.
  • REJECTED: Compliance check has failed due to validation or regulatory issues.
  • PENDING: Compliance check is still in progress.
Allowed values:
property_detailslist of objects or null

Array of property details associated with the third-party customer.

Multiple Properties Support: The response includes all properties associated with the third-party customer in the property_details array, allowing partners to view all property investments for a single customer profile.

Errors