Review
Customers represent the end users who send or receive payments through your integration. Each customer undergoes automatic identity verification and fraud screening upon creation. Use customers to track payment history, manage bank account connections, and maintain a secure record of all transactions associated with a user. Customers can be either individuals or businesses with appropriate compliance checks for each type.
Review a customer's identity results
Update a customer's verification status
Update a customer's identity decision
ModelsExpand Collapse
type CustomerReviewV1 struct{…}
Data CustomerReviewV1Data
CustomerDetails CustomerReviewV1DataCustomerDetails
Status string
An object containing the customer's address. This is optional, but if provided, all required fields must be present.
ComplianceProfile CustomerReviewV1DataCustomerDetailsComplianceProfileUnionoptional
PII required to trigger Patriot Act compliant KYC verification.
type CustomerReviewV1DataCustomerDetailsComplianceProfileBusinessComplianceProfile struct{…}
Business registration data required to trigger Patriot Act compliant KYB verification.
Config CustomerReviewV1DataCustomerDetailsConfigoptional
ProcessingMethod stringoptional
SandboxOutcome stringoptional
IdentityDetails CustomerReviewV1DataIdentityDetailsoptional
Breakdown CustomerReviewV1DataIdentityDetailsBreakdown
Detailed breakdown of the customer verification results, including decisions, risk scores, correlation score, and more.
Correlation IdentityVerificationBreakdownV1Correlationoptional
CorrelationScore float64optional
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
Correlation IdentityVerificationBreakdownV1Correlationoptional
CorrelationScore float64optional
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
Correlation IdentityVerificationBreakdownV1Correlationoptional
CorrelationScore float64optional
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
Correlation IdentityVerificationBreakdownV1Correlationoptional
CorrelationScore float64optional
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
Correlation IdentityVerificationBreakdownV1Correlationoptional
CorrelationScore float64optional
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
Correlation IdentityVerificationBreakdownV1Correlationoptional
CorrelationScore float64optional
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
Correlation IdentityVerificationBreakdownV1Correlationoptional
CorrelationScore float64optional
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
Correlation IdentityVerificationBreakdownV1Correlationoptional
CorrelationScore float64optional
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.
Decision string
KYC CustomerReviewV1DataIdentityDetailsKYCoptional
Messages map[string, string]optional
Dictionary of all messages from the customer verification process.
NetworkAlerts CustomerReviewV1DataIdentityDetailsNetworkAlertsoptional
Decision stringoptional
Reputation CustomerReviewV1DataIdentityDetailsReputationoptional
Decision stringoptional
WatchList CustomerReviewV1DataIdentityDetailsWatchListoptional
Decision stringoptional
Matches []CustomerReviewV1DataIdentityDetailsWatchListMatchoptional
Information about any matches found during screening.
Correlation string
Meta ResponseMetadata
ResponseType CustomerReviewV1ResponseType
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.
type IdentityVerificationBreakdownV1 struct{…}
Correlation IdentityVerificationBreakdownV1Correlationoptional
CorrelationScore float64optional
Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.