Get Third-Party Customer | Redpin

{
  "client_customer_details": {
    "client_customer_ref": "SKYLINE-CLIENT-001",
    "first_name": "Sarah",
    "last_name": "Johnson",
    "email": "sarah.johnson@example.com",
    "mobile_phone": "+14155552671",
    "country": "USA",
    "date_of_birth": "1985-03-15",
    "address": {
      "address_line": "123 Main St, Apt 4B",
      "city": "New York",
      "state": "NY",
      "post_code": "10001",
      "country": "USA"
    },
    "currency": "USD",
    "occupation": "Software Engineer",
    "employer_name": "Google",
    "income_range": {
      "currency": "GBP",
      "min_value": 10000,
      "max_value": 20000
    }
  },
  "status": "PENDING"
}

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

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

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.

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](/api-reference/customers/api-integration/third-parties/create-third-party-customer).

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.

Errors

404

Not Found Error

500

Internal Server Error