Get Third-Party Customer | Redpin

1 import requests 2 3 url = "https://api.redpincompany.com/v1/customers/020123456789/third-parties/SKYLINE-CLIENT-001" 4 5 headers = {"Authorization": "Bearer <token>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "client_customer_details": { 3 "client_customer_ref": "SKYLINE-CLIENT-001", 4 "first_name": "Sarah", 5 "last_name": "Johnson", 6 "email": "sarah.johnson@example.com", 7 "mobile_phone": "+14155552671", 8 "country": "USA", 9 "date_of_birth": "1985-03-15", 10 "address": { 11 "address_line": "123 Main St, Apt 4B", 12 "city": "New York", 13 "state": "NY", 14 "post_code": "10001", 15 "country": "USA" 16 }, 17 "currency": "USD", 18 "occupation": "Software Engineer", 19 "employer_name": "Google", 20 "income_range": { 21 "currency": "GBP", 22 "min_value": 10000, 23 "max_value": 20000 24 } 25 }, 26 "status": "APPROVED", 27 "property_details": [ 28 { 29 "property_ref": "SKYLINE_HEIGHTS/SKYLINE_TOWER/1001", 30 "unit_number": "1001", 31 "building_name": "Skyline Tower", 32 "project_name": "Skyline Heights Apartments", 33 "property_purchase_amount": { 34 "currency": "USD", 35 "value": 10000 36 }, 37 "payment_schedule": [ 38 { 39 "payment_date": "2024-01-15", 40 "amount": { 41 "currency": "currency", 42 "value": 1.1 43 } 44 } 45 ] 46 }, 47 { 48 "property_ref": "SKYLINE_HEIGHTS/SKYLINE_TOWER/1002", 49 "unit_number": "1002", 50 "building_name": "Skyline Tower", 51 "project_name": "Skyline Heights Apartments", 52 "property_purchase_amount": { 53 "currency": "USD", 54 "value": 12000 55 }, 56 "payment_schedule": [ 57 { 58 "payment_date": "2024-01-15", 59 "amount": { 60 "currency": "currency", 61 "value": 1.1 62 } 63 } 64 ] 65 } 66 ] 67 }

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

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

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.

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.

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.

Authentication

Path parameters

Response

Errors