Review
Review a customer's identity results
Update a customer's verification status
Update a customer's identity decision
ModelsExpand Collapse
CustomerReviewV1 { data, meta, response_type }
data: Data { customer_details, identity_details }
customer_details: CustomerDetails { 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" | "review" | "verified" | 2 more
type: "individual" | "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?: string | null
Secondary address line (e.g., apartment, suite, unit, or building).
compliance_profile?: IndividualComplianceProfile { dob, ssn } | BusinessComplianceProfile { ein, legal_business_name, representatives, website } | null
PII required to trigger Patriot Act compliant KYC verification.
IndividualComplianceProfile { dob, ssn }
PII required to trigger Patriot Act compliant KYC verification.
dob: string | null
Masked date of birth in ****-- format.
ssn: string | null
Masked Social Security Number in the format --***.
BusinessComplianceProfile { ein, legal_business_name, representatives, website }
Business registration data required to trigger Patriot Act compliant KYB verification.
ein: string | null
Masked Employer Identification Number in the format -*****
legal_business_name: string | null
The official registered name of the business. This name should be correlated with the ein value.
representatives?: Array<Representative> | null
A list of people related to the company. Only valid where customer type is 'business'.
website?: string | null
Official business website URL. Optional but recommended for enhanced KYB.
config?: Config { processing_method, sandbox_outcome }
processing_method?: "inline" | "background" | "skip"
sandbox_outcome?: "standard" | "verified" | "rejected" | "review"
device?: Device { 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?: string | null
Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.
metadata?: Record<string, string> | null
Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.
identity_details?: IdentityDetails { breakdown, created_at, decision, 7 more }
breakdown: Breakdown { address, business_evaluation, business_identification, 5 more }
Detailed breakdown of the customer verification results, including decisions, risk scores, correlation score, and more.
codes?: Array<string> | null
List of specific result codes from the fraud and risk screening.
correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
correlation_score?: number | null
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision?: "accept" | "reject" | "review"
risk_score?: number | null
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
business_evaluation?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }
codes?: Array<string> | null
List of specific result codes from the fraud and risk screening.
correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
correlation_score?: number | null
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision?: "accept" | "reject" | "review"
risk_score?: number | null
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
business_identification?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }
codes?: Array<string> | null
List of specific result codes from the fraud and risk screening.
correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
correlation_score?: number | null
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision?: "accept" | "reject" | "review"
risk_score?: number | null
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
business_validation?: IdentityVerificationBreakdownV1 { codes, correlation, correlation_score, 2 more }
codes?: Array<string> | null
List of specific result codes from the fraud and risk screening.
correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
correlation_score?: number | null
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision?: "accept" | "reject" | "review"
risk_score?: number | null
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
codes?: Array<string> | null
List of specific result codes from the fraud and risk screening.
correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
correlation_score?: number | null
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision?: "accept" | "reject" | "review"
risk_score?: number | null
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
codes?: Array<string> | null
List of specific result codes from the fraud and risk screening.
correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
correlation_score?: number | null
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision?: "accept" | "reject" | "review"
risk_score?: number | null
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
codes?: Array<string> | null
List of specific result codes from the fraud and risk screening.
correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
correlation_score?: number | null
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision?: "accept" | "reject" | "review"
risk_score?: number | null
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.
codes?: Array<string> | null
List of specific result codes from the fraud and risk screening.
correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
correlation_score?: number | null
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision?: "accept" | "reject" | "review"
risk_score?: number | null
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" | "reject" | "review"
review_id: string
Unique identifier for the review.
updated_at: string
Timestamp of the most recent update to the review.
kyc?: KYC { validations, codes, decision }
validations: Validations { address, city, dob, 7 more }
Boolean values indicating the result of each validation in the KYC process.
codes?: Array<string> | null
List of specific result codes from the KYC screening process.
decision?: "accept" | "reject" | "review"
messages?: Record<string, string> | null
Dictionary of all messages from the customer verification process.
network_alerts?: NetworkAlerts { alerts, codes, decision }
alerts?: Array<string> | null
Any alerts or flags raised during the consortium alert screening.
codes?: Array<string> | null
List of specific result codes from the consortium alert screening.
decision?: "accept" | "reject" | "review"
reputation?: Reputation { codes, decision, insights, risk_score }
codes?: Array<string> | null
Specific codes related to the Straddle reputation screening results.
decision?: "accept" | "reject" | "review"
insights?: Insights { accounts_active_count, accounts_closed_count, accounts_closed_dates, 30 more }
watch_list?: WatchList { codes, decision, matched, matches }
codes?: Array<string> | null
Specific codes related to the Straddle watchlist screening results.
decision?: "accept" | "reject" | "review"
matched?: Array<string> | null
Information about any matches found during screening.
matches?: Array<Match> | null
Information about any matches found during screening.
correlation: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
list_name: string
The name of the list the match was found.
match_fields: Array<string>
Data fields that matched.
urls: Array<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" | "array" | "error" | "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 { codes, correlation, correlation_score, 2 more }
codes?: Array<string> | null
List of specific result codes from the fraud and risk screening.
correlation?: "low_confidence" | "potential_match" | "likely_match" | "high_confidence"
correlation_score?: number | null
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
decision?: "accept" | "reject" | "review"
risk_score?: number | null
Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.