> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.redpincompany.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.redpincompany.com/_mcp/server. # Get Third-Party Customer GET https://sandbox.currenciesdirect.com/v1/customers/{customer_id}/third-parties/{client_customer_ref} 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](/api-guide/getting-started/authentication#oauth-20-authentication) Reference: https://docs.redpincompany.com/api-reference/customers/api-integration/third-parties/get-third-party-customer ## Authentication - `Authorization` header (bearer token, required) — OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the [Authentication](/api-guide/getting-started/authentication#oauth-20-authentication) section for detailed information on how to obtain and use your OAuth credentials. ## Servers - `https://sandbox.currenciesdirect.com` (Sandbox, default) - `https://api.redpincompany.com` (Production) ## Request ### Path parameters - `customer_id` (string, required) — Unique identifier of the partner platform retrieving the third-party customer. - `client_customer_ref` (string, required) — 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 ### 200 Third-party customer details retrieved successfully - `client_customer_details` (ClientCustomerDetails, required) - `status` (enum, required) — 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: `APPROVED`, `REJECTED`, `PENDING` ## Errors ### 404 Not Found Error Third-party customer not found - `code` (string, required) - `description` (string, required) — Human-readable error description - `type` (enum, optional) — Category or type of the error. - `VALIDATION_ERROR`: Error due to invalid input data or format - `AUTHORIZATION_ERROR`: Error related to insufficient permissions - `SYSTEM_ERROR`: Internal system or server errors - `RESOURCE_ERROR`: Error related to resource availability - `BUSINESS_ERROR`: Error related to business logic violations - `DATA_ERROR`: Error related to data inconsistencies or duplication - Allowed values: `VALIDATION_ERROR`, `AUTHORIZATION_ERROR`, `SYSTEM_ERROR`, `RESOURCE_ERROR`, `BUSINESS_ERROR`, `DATA_ERROR` - `field` (string, optional) - `details` (map from string to any, optional) — Additional details about the error - `timestamp` (datetime, optional) ### 500 Internal Server Error Internal server error - `code` (string, required) - `description` (string, required) — Human-readable error description - `type` (enum, optional) — Category or type of the error. - `VALIDATION_ERROR`: Error due to invalid input data or format - `AUTHORIZATION_ERROR`: Error related to insufficient permissions - `SYSTEM_ERROR`: Internal system or server errors - `RESOURCE_ERROR`: Error related to resource availability - `BUSINESS_ERROR`: Error related to business logic violations - `DATA_ERROR`: Error related to data inconsistencies or duplication - Allowed values: `VALIDATION_ERROR`, `AUTHORIZATION_ERROR`, `SYSTEM_ERROR`, `RESOURCE_ERROR`, `BUSINESS_ERROR`, `DATA_ERROR` - `field` (string, optional) - `details` (map from string to any, optional) — Additional details about the error - `timestamp` (datetime, optional) ## Types ### ClientCustomerDetails - `client_customer_ref` (string, required) — Partner's internal reference/ID for this customer. - `first_name` (string, required) — Third-party Customer's first name - `last_name` (string, required) — Third-party Customer's last name - `email` (string, required) — Third-party Customer's email address - `mobile_phone` (string, required) — Third-party Customer's mobile phone number in E.164 international format (e.g., +14155552671) - `country` (string, required) — ISO 3166-1 alpha-3 country code representing the third party customer's legal nationality or citizenship status. See [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the complete list of country codes. - `date_of_birth` (string, required) — Third-party Customer's date of birth in ISO 8601 format (YYYY-MM-DD) - `address` (address, required) - `currency` (string, optional) — 3-letter ISO currency code for the third party customer's preferred currency. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) for the complete list of currency codes. - `occupation` (string, optional) — Third-party customer's occupation - `employer_name` (string, optional) — Name of the third-party customer's employer - `income_range` (IncomeRange, optional) — Third party customer's income range in the given currency ### address - `address_line` (string, required) — Full street address of the customer, including apartment or unit number if applicable. Example: "123 Main St, Apt 4B" - `city` (string, required) — City or town of the customer's residence. Example: "New York" - `state` (string, required) — State, province, or region associated with the address. This field is required for countries that use regional subdivisions. Example: "NY" - `post_code` (string, required) — ZIP code, postal code, or equivalent regional code used for mail delivery. Example: "10001" - `country` (string, required) — 3-letter [ISO 3166-1] (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code (e.g., USA, GBR, IND) representing the country of residence. Example: "USA" ### IncomeRange Third party customer's income range in the given currency - `currency` (string, required) — 3-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the income range. - `min_value` (double, required) — Minimum value of the income range - `max_value` (double, required) — Maximum value of the income range ## Examples **Response** ```json { "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" } ``` **SDK Code** ```python Get Third-Party Customer Details Success Response import requests url = "https://sandbox.currenciesdirect.com/v1/customers/020123456789/third-parties/SKYLINE-CLIENT-001" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Get Third-Party Customer Details Success Response const url = 'https://sandbox.currenciesdirect.com/v1/customers/020123456789/third-parties/SKYLINE-CLIENT-001'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Get Third-Party Customer Details Success Response package main import ( "fmt" "net/http" "io" ) func main() { url := "https://sandbox.currenciesdirect.com/v1/customers/020123456789/third-parties/SKYLINE-CLIENT-001" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Get Third-Party Customer Details Success Response require 'uri' require 'net/http' url = URI("https://sandbox.currenciesdirect.com/v1/customers/020123456789/third-parties/SKYLINE-CLIENT-001") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Get Third-Party Customer Details Success Response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://sandbox.currenciesdirect.com/v1/customers/020123456789/third-parties/SKYLINE-CLIENT-001") .header("Authorization", "Bearer ") .asString(); ``` ```php Get Third-Party Customer Details Success Response request('GET', 'https://sandbox.currenciesdirect.com/v1/customers/020123456789/third-parties/SKYLINE-CLIENT-001', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Get Third-Party Customer Details Success Response using RestSharp; var client = new RestClient("https://sandbox.currenciesdirect.com/v1/customers/020123456789/third-parties/SKYLINE-CLIENT-001"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Get Third-Party Customer Details Success Response import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.currenciesdirect.com/v1/customers/020123456789/third-parties/SKYLINE-CLIENT-001")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```