Fundamentals
Customers
Charges
Payouts
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Lookup a customer
Use this endpoint to retrieve a customer record by its unique id.
curl --request GET \
--url https://{environment}.straddle.io/v1/customers/{id} \
--header 'Authorization: <api-key>'{
"meta": {
"api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_request_timestamp": "2023-11-07T05:31:56Z"
},
"response_type": "object",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"name": "<string>",
"type": "individual",
"email": "<string>",
"phone": "<string>",
"external_id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"address": {
"address1": "<string>",
"address2": "<string>",
"type": "residential",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
},
"compliance_profile": {
"dob": "<string>",
"ssn": "<string>",
"ein": "<string>",
"registration_state": "<string>",
"website": "<string>"
},
"device": {
"ip_address": "<string>"
},
"metadata": {}
}
}Authorizations
JWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.
Headers
For use by platforms to specify an account id and set scope of a request.
Optional client generated identifier to trace and debug a request.
Optional client generated identifier to trace and debug a series of requests.
Path Parameters
Response
object, array, error, none Unique identifier for the customer.
A human-readable label for the customer.
Full name of the individual or business name.
individual, business The customer's email address.
The customer's phone number in E.164 format.
pending, review, verified, inactive, rejected Timestamp of when the customer record was created.
Timestamp of the most recent update to the customer record.
Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.
Primary address line (e.g., street, PO Box).
residential, commercial City, district, suburb, town, or village.
Two-letter state code.
Zip or postal code.
Secondary address line (e.g., apartment, suite, unit, or building).
Date of birth for individual customers in ISO 8601 format (YYYY-MM-DD). This data is required to trigger Patriot Act compliant Know Your Customer (KYC) verification. Required if SSN is provided. Only valid where customer type is 'individual'.
Full 9-digit Social Security Number or government identifier for individuals. This data is required to trigger Patriot Act compliant KYC verification. Required if DOB is provided. Only valid where customer type is 'individual'.
Full 9-digit Employer Identification Number for businesses. This data is required to trigger Patriot Act compliant Know Your Business (KYB) verification. Only valid where customer type is 'business'.
Two-letter abbreviation of the state where the business was originally registered. This data is required to trigger Patriot Act compliant KYB verification. Only valid where customer type is 'business'.
URL of the company's official website. Only valid where customer type is 'business'.
The customer's IP address at the time of profile creation. Use '0.0.0.0' to represent an offline customer registration.
1curl --request GET \
--url https://{environment}.straddle.io/v1/customers/{id} \
--header 'Authorization: <api-key>'{
"meta": {
"api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_request_timestamp": "2023-11-07T05:31:56Z"
},
"response_type": "object",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"name": "<string>",
"type": "individual",
"email": "<string>",
"phone": "<string>",
"external_id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"address": {
"address1": "<string>",
"address2": "<string>",
"type": "residential",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
},
"compliance_profile": {
"dob": "<string>",
"ssn": "<string>",
"ein": "<string>",
"registration_state": "<string>",
"website": "<string>"
},
"device": {
"ip_address": "<string>"
},
"metadata": {}
}
}