Review
Review a customer's identity results
Update a customer's verification status
Update a customer's identity decision
ModelsExpand Collapse
CustomerReviewV1 = object { data, meta, response_type }
data: object { customer_details, identity_details }
customer_details: object { id, created_at, email, 11 more }
id: string
Unique identifier for the customer.
created_at: string
Timestamp of when the customer record was created.
email: string
The customer's email address.
name: string
Full name of the individual or business name.
phone: string
The customer's phone number in E.164 format.
status: "pending" or "review" or "verified" or 2 more
type: "individual" or "business"
updated_at: string
Timestamp of the most recent update to the customer record.
An object containing the customer's address. This is optional, but if provided, all required fields must be present.
address1: string
Primary address line (e.g., street, PO Box).
city: string
City, district, suburb, town, or village.
state: string
Two-letter state code.
zip: string
Zip or postal code.
address2: optional string
Secondary address line (e.g., apartment, suite, unit, or building).
compliance_profile: optional object { dob, ssn } or object { ein, legal_business_name, representatives, website }
PII required to trigger Patriot Act compliant KYC verification.
IndividualComplianceProfile = object { dob, ssn }
PII required to trigger Patriot Act compliant KYC verification.
dob: string
Masked date of birth in ****-- format.
ssn: string
Masked Social Security Number in the format --***.
BusinessComplianceProfile = object { ein, legal_business_name, representatives, website }
Business registration data required to trigger Patriot Act compliant KYB verification.
ein: string
Masked Employer Identification Number in the format -*****
legal_business_name: string
The official registered name of the business. This name should be correlated with the ein value.
representatives: optional array of object { name, email, phone }
A list of people related to the company. Only valid where customer type is 'business'.
website: optional string
Official business website URL. Optional but recommended for enhanced KYB.
config: optional object { processing_method, sandbox_outcome }
processing_method: optional "inline" or "background" or "skip"
sandbox_outcome: optional "standard" or "verified" or "rejected" or "review"
device: optional object { ip_address }
ip_address: string
The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.
external_id: optional string
Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.
metadata: optional map[string]
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.
identity_details: optional object { breakdown, created_at, decision, 7 more }
breakdown: object { address, business_evaluation, business_identification, 5 more }
Detailed breakdown of the customer verification results, including decisions, risk scores, correlation score, and more.
codes: optional array of string
List of specific result codes from the fraud and risk screening.
correlation: optional "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
correlation_score: optional number
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: optional "accept" or "reject" or "review"
risk_score: optional number
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
business_evaluation: optional IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }
codes: optional array of string
List of specific result codes from the fraud and risk screening.
correlation: optional "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
correlation_score: optional number
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: optional "accept" or "reject" or "review"
risk_score: optional number
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
business_identification: optional IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }
codes: optional array of string
List of specific result codes from the fraud and risk screening.
correlation: optional "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
correlation_score: optional number
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: optional "accept" or "reject" or "review"
risk_score: optional number
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
business_validation: optional IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }
codes: optional array of string
List of specific result codes from the fraud and risk screening.
correlation: optional "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
correlation_score: optional number
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: optional "accept" or "reject" or "review"
risk_score: optional number
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
codes: optional array of string
List of specific result codes from the fraud and risk screening.
correlation: optional "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
correlation_score: optional number
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: optional "accept" or "reject" or "review"
risk_score: optional number
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
codes: optional array of string
List of specific result codes from the fraud and risk screening.
correlation: optional "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
correlation_score: optional number
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: optional "accept" or "reject" or "review"
risk_score: optional number
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
codes: optional array of string
List of specific result codes from the fraud and risk screening.
correlation: optional "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
correlation_score: optional number
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: optional "accept" or "reject" or "review"
risk_score: optional number
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
synthetic: optional IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }
codes: optional array of string
List of specific result codes from the fraud and risk screening.
correlation: optional "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
correlation_score: optional number
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: optional "accept" or "reject" or "review"
risk_score: optional number
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
created_at: string
Timestamp of when the review was initiated.
decision: "accept" or "reject" or "review"
review_id: string
Unique identifier for the review.
updated_at: string
Timestamp of the most recent update to the review.
kyc: optional object { validations, codes, decision }
validations: object { address, city, dob, 7 more }
Boolean values indicating the result of each validation in the KYC process.
codes: optional array of string
List of specific result codes from the KYC screening process.
decision: optional "accept" or "reject" or "review"
messages: optional map[string]
Dictionary of all messages from the customer verification process.
network_alerts: optional object { alerts, codes, decision }
alerts: optional array of string
Any alerts or flags raised during the consortium alert screening.
codes: optional array of string
List of specific result codes from the consortium alert screening.
decision: optional "accept" or "reject" or "review"
reputation: optional object { codes, decision, insights, risk_score }
codes: optional array of string
Specific codes related to the Straddle reputation screening results.
decision: optional "accept" or "reject" or "review"
insights: optional object { accounts_active_count, accounts_closed_count, accounts_closed_dates, 30 more }
watch_list: optional object { codes, decision, matched, matches }
codes: optional array of string
Specific codes related to the Straddle watchlist screening results.
decision: optional "accept" or "reject" or "review"
matched: optional array of string
Information about any matches found during screening.
matches: optional array of object { correlation, list_name, match_fields, urls }
Information about any matches found during screening.
correlation: "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
list_name: string
The name of the list the match was found.
match_fields: array of string
Data fields that matched.
urls: array of string
Relevent Urls to review.
Metadata about the API request, including an identifier and timestamp.
api_request_id: string
Unique identifier for this API request, useful for troubleshooting.
api_request_timestamp: string
Timestamp for this API request, useful for troubleshooting.
response_type: "object" or "array" or "error" or "none"
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.
IdentityVerificationBreakdownV1 = object { codes, correlation, correlation_score, 2 more }
codes: optional array of string
List of specific result codes from the fraud and risk screening.
correlation: optional "low_confidence" or "potential_match" or "likely_match" or "high_confidence"
correlation_score: optional number
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision: optional "accept" or "reject" or "review"
risk_score: optional number
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.