Fundamentals
Customers
Charges
Payouts
Payments
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Review a customer
Use this endpoint to review the identity and risk scores of an existing customer.
curl --request GET \
--header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
--url https://sandbox.straddle.io/v1/customers/<uuid>/review{
"meta": {
"api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_request_timestamp": "2023-11-07T05:31:56Z"
},
"response_type": "object",
"data": {
"customer_details": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Ron Swanson",
"type": "individual",
"email": "ron.swanson@pawnee.com",
"phone": "+12128675309",
"external_id": "<string>",
"status": "verified",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"address": {
"address1": "123 Main St",
"address2": "Apt 1",
"city": "Anytown",
"state": "CA",
"zip": "12345"
},
"compliance_profile": {
"dob": "****-**-**",
"ssn": "***-**-****"
},
"device": {
"ip_address": "192.168.1.1"
},
"metadata": {}
},
"identity_details": {
"review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"decision": "accept",
"messages": {},
"breakdown": {
"address": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"email": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"fraud": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"phone": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"synthetic": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"business_identification": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"business_validation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"business_evaluation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
}
},
"network_alerts": {
"decision": "accept",
"codes": [
"<string>"
],
"alerts": [
"<string>"
]
},
"watch_list": {
"decision": "accept",
"codes": [
"<string>"
],
"matched": [
"<string>"
],
"matches": [
{
"list_name": "<string>",
"urls": [
"<string>"
],
"match_fields": [
"<string>"
],
"correlation": "low_confidence"
}
]
},
"kyc": {
"decision": "accept",
"codes": [
"<string>"
],
"validations": {
"first_name": true,
"last_name": true,
"address": true,
"city": true,
"state": true,
"zip": true,
"phone": true,
"dob": true,
"ssn": true,
"email": true
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}Authorizations
Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.
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
Indicates the structure of the returned content.
- "object" means the
datafield contains a single JSON object. - "array" means the
datafield contains an array of objects. - "error" means the
datafield contains an error object with details of the issue. - "none" means no data is returned.
object, array, error, none Unique identifier for the customer.
Full name of the individual or business name.
"Ron Swanson"
individual, business The customer's email address.
"ron.swanson@pawnee.com"
The customer's phone number in E.164 format.
"+12128675309"
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.
An object containing the customer's address. This is optional, but if provided, all required fields must be present.
Primary address line (e.g., street, PO Box).
100"123 Main St"
City, district, suburb, town, or village.
100"Anytown"
Two-letter state code.
"CA"
Zip or postal code.
"12345"
Secondary address line (e.g., apartment, suite, unit, or building).
100"Apt 1"
PII required to trigger Patriot Act compliant KYC verification.
The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.
1"192.168.1.1"
Unique identifier for the review.
accept, reject, review Detailed breakdown of the customer verification results, including decisions, risk scores, correlation score, and more.
accept, reject, review List of specific result codes from the fraud and risk screening.
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept, reject, review List of specific result codes from the fraud and risk screening.
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept, reject, review List of specific result codes from the fraud and risk screening.
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept, reject, review List of specific result codes from the fraud and risk screening.
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept, reject, review List of specific result codes from the fraud and risk screening.
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept, reject, review List of specific result codes from the fraud and risk screening.
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept, reject, review List of specific result codes from the fraud and risk screening.
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
accept, reject, review List of specific result codes from the fraud and risk screening.
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
Timestamp of when the review was initiated.
Timestamp of the most recent update to the review.
Dictionary of all messages from the customer verification process.
accept, reject, review List of specific result codes from the consortium alert screening.
Any alerts or flags raised during the consortium alert screening.
accept, reject, review Specific codes related to the Straddle watchlist screening results.
Information about any matches found during screening.
Information about any matches found during screening.
The name of the list the match was found.
Relevent Urls to review.
Data fields that matched.
low_confidence, potential_match, likely_match, high_confidence Boolean values indicating the result of each validation in the KYC process.
accept, reject, review List of specific result codes from the KYC screening process.
curl --request GET \
--header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
--url https://sandbox.straddle.io/v1/customers/<uuid>/review{
"meta": {
"api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"api_request_timestamp": "2023-11-07T05:31:56Z"
},
"response_type": "object",
"data": {
"customer_details": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Ron Swanson",
"type": "individual",
"email": "ron.swanson@pawnee.com",
"phone": "+12128675309",
"external_id": "<string>",
"status": "verified",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"address": {
"address1": "123 Main St",
"address2": "Apt 1",
"city": "Anytown",
"state": "CA",
"zip": "12345"
},
"compliance_profile": {
"dob": "****-**-**",
"ssn": "***-**-****"
},
"device": {
"ip_address": "192.168.1.1"
},
"metadata": {}
},
"identity_details": {
"review_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"decision": "accept",
"messages": {},
"breakdown": {
"address": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"email": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"fraud": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"phone": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"synthetic": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"business_identification": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"business_validation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
},
"business_evaluation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123
}
},
"network_alerts": {
"decision": "accept",
"codes": [
"<string>"
],
"alerts": [
"<string>"
]
},
"watch_list": {
"decision": "accept",
"codes": [
"<string>"
],
"matched": [
"<string>"
],
"matches": [
{
"list_name": "<string>",
"urls": [
"<string>"
],
"match_fields": [
"<string>"
],
"correlation": "low_confidence"
}
]
},
"kyc": {
"decision": "accept",
"codes": [
"<string>"
],
"validations": {
"first_name": true,
"last_name": true,
"address": true,
"city": true,
"state": true,
"zip": true,
"phone": true,
"dob": true,
"ssn": true,
"email": true
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}