Fundamentals
Customers
Charges
Payouts
Payments
Embed
- Organizations
- Accounts
- Representatives
- Linked Bank Accounts
- Capability Requests
Customers
Review a customer
Use this endpoint to review the identity and risk scores of an existing customer.
GET
/
v1
/
customers
/
{id}
/
review
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,
"correlation": "low_confidence"
},
"email": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"fraud": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"phone": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"synthetic": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"business_identification": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"business_validation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"business_evaluation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
}
},
"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",
"reputation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"insights": {
"ach_fraud_transactions_count": 123,
"ach_fraud_transactions_total_amount": 123,
"ach_fraud_transactions_dates": [
"2023-12-25"
],
"ach_returned_transactions_count": 123,
"ach_returned_transactions_total_amount": 123,
"ach_returned_transactions_dates": [
"2023-12-25"
],
"card_fraud_transactions_count": 123,
"card_fraud_transactions_total_amount": 123,
"card_fraud_transactions_dates": [
"2023-12-25"
],
"card_disputed_transactions_count": 123,
"card_disputed_transactions_total_amount": 123,
"card_disputed_transactions_dates": [
"2023-12-25"
],
"card_stopped_transactions_count": 123,
"card_stopped_transactions_dates": [
"2023-12-25"
],
"accounts_count": 123,
"accounts_active_count": 123,
"accounts_closed_count": 123,
"accounts_closed_dates": [
"2023-12-25"
],
"accounts_fraud_count": 123,
"accounts_fraud_loss_total_amount": 123,
"accounts_fraud_labeled_dates": [
"2023-12-25"
],
"applications_count": 123,
"applications_dates": [
"2023-12-25"
],
"applications_approved_count": 123,
"applications_declined_count": 123,
"applications_fraud_count": 123,
"user_institution_count": 123,
"user_dob_count": 123,
"user_mobile_count": 123,
"user_email_count": 123,
"user_address_count": 123,
"user_active_profile_count": 123,
"user_closed_profile_count": 123
}
}
}
}
}
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
200
text/plain
OK
The response is of type object
.
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,
"correlation": "low_confidence"
},
"email": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"fraud": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"phone": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"synthetic": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"business_identification": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"business_validation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
},
"business_evaluation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"correlation_score": 123,
"correlation": "low_confidence"
}
},
"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",
"reputation": {
"decision": "accept",
"codes": [
"<string>"
],
"risk_score": 123,
"insights": {
"ach_fraud_transactions_count": 123,
"ach_fraud_transactions_total_amount": 123,
"ach_fraud_transactions_dates": [
"2023-12-25"
],
"ach_returned_transactions_count": 123,
"ach_returned_transactions_total_amount": 123,
"ach_returned_transactions_dates": [
"2023-12-25"
],
"card_fraud_transactions_count": 123,
"card_fraud_transactions_total_amount": 123,
"card_fraud_transactions_dates": [
"2023-12-25"
],
"card_disputed_transactions_count": 123,
"card_disputed_transactions_total_amount": 123,
"card_disputed_transactions_dates": [
"2023-12-25"
],
"card_stopped_transactions_count": 123,
"card_stopped_transactions_dates": [
"2023-12-25"
],
"accounts_count": 123,
"accounts_active_count": 123,
"accounts_closed_count": 123,
"accounts_closed_dates": [
"2023-12-25"
],
"accounts_fraud_count": 123,
"accounts_fraud_loss_total_amount": 123,
"accounts_fraud_labeled_dates": [
"2023-12-25"
],
"applications_count": 123,
"applications_dates": [
"2023-12-25"
],
"applications_approved_count": 123,
"applications_declined_count": 123,
"applications_fraud_count": 123,
"user_institution_count": 123,
"user_dob_count": 123,
"user_mobile_count": 123,
"user_email_count": 123,
"user_address_count": 123,
"user_active_profile_count": 123,
"user_closed_profile_count": 123
}
}
}
}
}