Review a customer's identity results
client.customers.review.get(stringid, ReviewGetParams { correlationID, requestID, straddleAccountID } params?, RequestOptionsoptions?): CustomerReviewV1 { data, meta, response_type }
/v1/customers/{id}/review
Retrieves and analyzes the results of a customer's identity validation and fraud score. This endpoint provides a comprehensive breakdown of the validation outcome, including:
- Risk and correlation scores
- Reason codes for the decision
- Results of watchlist screening
- Any network alerts detected Use this endpoint to gain insights into the verification process and make informed decisions about customer onboarding.
Parameters
id: string
Returns
Review a customer's identity results
import Straddle from '@straddlecom/straddle';
const client = new Straddle({
apiKey: 'My API Key',
});
const customerReviewV1 = await client.customers.review.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(customerReviewV1.data);
{
"data": {
"customer_details": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"email": "ron.swanson@pawnee.com",
"name": "Ron Swanson",
"phone": "+12128675309",
"status": "pending",
"type": "individual",
"updated_at": "2019-12-27T18:11:19.117Z",
"address": {
"address1": "123 Main St",
"city": "Anytown",
"state": "CA",
"zip": "12345",
"address2": "Apt 1"
},
"compliance_profile": {
"dob": "2019-12-27",
"ssn": "***-**-****"
},
"config": {
"processing_method": "inline",
"sandbox_outcome": "standard"
},
"device": {
"ip_address": "192.168.1.1"
},
"external_id": "external_id",
"metadata": {
"foo": "string"
}
},
"identity_details": {
"breakdown": {
"address": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"business_evaluation": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"business_identification": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"business_validation": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"email": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"fraud": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"phone": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"synthetic": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
}
},
"created_at": "2019-12-27T18:11:19.117Z",
"decision": "accept",
"review_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"updated_at": "2019-12-27T18:11:19.117Z",
"kyc": {
"validations": {
"address": true,
"city": true,
"dob": true,
"email": true,
"first_name": true,
"last_name": true,
"phone": true,
"ssn": true,
"state": true,
"zip": true
},
"codes": [
"string"
],
"decision": "accept"
},
"messages": {
"foo": "string"
},
"network_alerts": {
"alerts": [
"string"
],
"codes": [
"string"
],
"decision": "accept"
},
"reputation": {
"codes": [
"string"
],
"decision": "accept",
"insights": {
"accounts_active_count": 0,
"accounts_closed_count": 0,
"accounts_closed_dates": [
"2019-12-27"
],
"accounts_count": 0,
"accounts_fraud_count": 0,
"accounts_fraud_labeled_dates": [
"2019-12-27"
],
"accounts_fraud_loss_total_amount": 0,
"ach_fraud_transactions_count": 0,
"ach_fraud_transactions_dates": [
"2019-12-27"
],
"ach_fraud_transactions_total_amount": 0,
"ach_returned_transactions_count": 0,
"ach_returned_transactions_dates": [
"2019-12-27"
],
"ach_returned_transactions_total_amount": 0,
"applications_approved_count": 0,
"applications_count": 0,
"applications_dates": [
"2019-12-27"
],
"applications_declined_count": 0,
"applications_fraud_count": 0,
"card_disputed_transactions_count": 0,
"card_disputed_transactions_dates": [
"2019-12-27"
],
"card_disputed_transactions_total_amount": 0,
"card_fraud_transactions_count": 0,
"card_fraud_transactions_dates": [
"2019-12-27"
],
"card_fraud_transactions_total_amount": 0,
"card_stopped_transactions_count": 0,
"card_stopped_transactions_dates": [
"2019-12-27"
],
"user_active_profile_count": 0,
"user_address_count": 0,
"user_closed_profile_count": 0,
"user_dob_count": 0,
"user_email_count": 0,
"user_institution_count": 0,
"user_mobile_count": 0
},
"risk_score": 0
},
"watch_list": {
"codes": [
"string"
],
"decision": "accept",
"matched": [
"string"
],
"matches": [
{
"correlation": "low_confidence",
"list_name": "list_name",
"match_fields": [
"string"
],
"urls": [
"string"
]
}
]
}
}
},
"meta": {
"api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"api_request_timestamp": "2019-12-27T18:11:19.117Z"
},
"response_type": "object"
}Returns Examples
{
"data": {
"customer_details": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"email": "ron.swanson@pawnee.com",
"name": "Ron Swanson",
"phone": "+12128675309",
"status": "pending",
"type": "individual",
"updated_at": "2019-12-27T18:11:19.117Z",
"address": {
"address1": "123 Main St",
"city": "Anytown",
"state": "CA",
"zip": "12345",
"address2": "Apt 1"
},
"compliance_profile": {
"dob": "2019-12-27",
"ssn": "***-**-****"
},
"config": {
"processing_method": "inline",
"sandbox_outcome": "standard"
},
"device": {
"ip_address": "192.168.1.1"
},
"external_id": "external_id",
"metadata": {
"foo": "string"
}
},
"identity_details": {
"breakdown": {
"address": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"business_evaluation": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"business_identification": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"business_validation": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"email": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"fraud": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"phone": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
},
"synthetic": {
"codes": [
"string"
],
"correlation": "low_confidence",
"correlation_score": 0,
"decision": "accept",
"risk_score": 0
}
},
"created_at": "2019-12-27T18:11:19.117Z",
"decision": "accept",
"review_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"updated_at": "2019-12-27T18:11:19.117Z",
"kyc": {
"validations": {
"address": true,
"city": true,
"dob": true,
"email": true,
"first_name": true,
"last_name": true,
"phone": true,
"ssn": true,
"state": true,
"zip": true
},
"codes": [
"string"
],
"decision": "accept"
},
"messages": {
"foo": "string"
},
"network_alerts": {
"alerts": [
"string"
],
"codes": [
"string"
],
"decision": "accept"
},
"reputation": {
"codes": [
"string"
],
"decision": "accept",
"insights": {
"accounts_active_count": 0,
"accounts_closed_count": 0,
"accounts_closed_dates": [
"2019-12-27"
],
"accounts_count": 0,
"accounts_fraud_count": 0,
"accounts_fraud_labeled_dates": [
"2019-12-27"
],
"accounts_fraud_loss_total_amount": 0,
"ach_fraud_transactions_count": 0,
"ach_fraud_transactions_dates": [
"2019-12-27"
],
"ach_fraud_transactions_total_amount": 0,
"ach_returned_transactions_count": 0,
"ach_returned_transactions_dates": [
"2019-12-27"
],
"ach_returned_transactions_total_amount": 0,
"applications_approved_count": 0,
"applications_count": 0,
"applications_dates": [
"2019-12-27"
],
"applications_declined_count": 0,
"applications_fraud_count": 0,
"card_disputed_transactions_count": 0,
"card_disputed_transactions_dates": [
"2019-12-27"
],
"card_disputed_transactions_total_amount": 0,
"card_fraud_transactions_count": 0,
"card_fraud_transactions_dates": [
"2019-12-27"
],
"card_fraud_transactions_total_amount": 0,
"card_stopped_transactions_count": 0,
"card_stopped_transactions_dates": [
"2019-12-27"
],
"user_active_profile_count": 0,
"user_address_count": 0,
"user_closed_profile_count": 0,
"user_dob_count": 0,
"user_email_count": 0,
"user_institution_count": 0,
"user_mobile_count": 0
},
"risk_score": 0
},
"watch_list": {
"codes": [
"string"
],
"decision": "accept",
"matched": [
"string"
],
"matches": [
{
"correlation": "low_confidence",
"list_name": "list_name",
"match_fields": [
"string"
],
"urls": [
"string"
]
}
]
}
}
},
"meta": {
"api_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"api_request_timestamp": "2019-12-27T18:11:19.117Z"
},
"response_type": "object"
}