Customers

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.

Lookup a customer

client.Customers.Get(ctx, id, query) (*CustomerV1, error)

GET/v1/customers/{id}

Update a customer

client.Customers.Update(ctx, id, params) (*CustomerV1, error)

PUT/v1/customers/{id}

Delete a customer

client.Customers.Delete(ctx, id, body) (*CustomerV1, error)

DELETE/v1/customers/{id}

List customers

client.Customers.List(ctx, params) (*PageNumberSchema[CustomerSummaryPagedV1Data], error)

GET/v1/customers

Create a customer

client.Customers.New(ctx, params) (*CustomerV1, error)

POST/v1/customers

Unmask customer data

client.Customers.Unmasked(ctx, id, query) (*CustomerUnmaskedV1, error)

GET/v1/customers/{id}/unmasked

ModelsExpand Collapse

type CustomerAddressV1 struct{…}

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).

maxLength100

City string

City, district, suburb, town, or village.

maxLength100

State string

Two-letter state code.

Zip string

Zip or postal code.

Address2 stringoptional

Secondary address line (e.g., apartment, suite, unit, or building).

maxLength100

type CustomerSummaryPagedV1 struct{…}

Data []CustomerSummaryPagedV1Data

ID string

Unique identifier for the customer.

formatuuid

CreatedAt Time

Timestamp of when the customer record was created.

formatdate-time

Email string

The customer's email address.

formatemail

Name string

Full name of the individual or business name.

Phone string

The customer's phone number in E.164 format.

Status string

One of the following:

const CustomerSummaryPagedV1DataStatusPending CustomerSummaryPagedV1DataStatus = "pending"

const CustomerSummaryPagedV1DataStatusReview CustomerSummaryPagedV1DataStatus = "review"

const CustomerSummaryPagedV1DataStatusVerified CustomerSummaryPagedV1DataStatus = "verified"

const CustomerSummaryPagedV1DataStatusInactive CustomerSummaryPagedV1DataStatus = "inactive"

const CustomerSummaryPagedV1DataStatusRejected CustomerSummaryPagedV1DataStatus = "rejected"

Type string

One of the following:

const CustomerSummaryPagedV1DataTypeIndividual CustomerSummaryPagedV1DataType = "individual"

const CustomerSummaryPagedV1DataTypeBusiness CustomerSummaryPagedV1DataType = "business"

UpdatedAt Time

Timestamp of the most recent update to the customer record.

formatdate-time

ExternalID stringoptional

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

Meta CustomerSummaryPagedV1Meta

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

MaxPageSize int64

Maximum allowed page size for this endpoint.

formatint32

PageNumber int64

Page number for paginated results.

formatint32

PageSize int64

Number of items per page in this response.

formatint32

SortBy string

The field that the results were sorted by.

SortOrder string

One of the following:

const CustomerSummaryPagedV1MetaSortOrderAsc CustomerSummaryPagedV1MetaSortOrder = "asc"

const CustomerSummaryPagedV1MetaSortOrderDesc CustomerSummaryPagedV1MetaSortOrder = "desc"

TotalItems int64

TotalPages int64

The number of pages available.

formatint32

ResponseType CustomerSummaryPagedV1ResponseType

Indicates the structure of the returned content.

"object" means the data field contains a single JSON object.
"array" means the data field contains an array of objects.
"error" means the data field contains an error object with details of the issue.
"none" means no data is returned.

One of the following:

const CustomerSummaryPagedV1ResponseTypeObject CustomerSummaryPagedV1ResponseType = "object"

const CustomerSummaryPagedV1ResponseTypeArray CustomerSummaryPagedV1ResponseType = "array"

const CustomerSummaryPagedV1ResponseTypeError CustomerSummaryPagedV1ResponseType = "error"

const CustomerSummaryPagedV1ResponseTypeNone CustomerSummaryPagedV1ResponseType = "none"

type CustomerUnmaskedV1 struct{…}

Data CustomerUnmaskedV1Data

ID string

Unique identifier for the customer.

formatuuid

CreatedAt Time

Timestamp of when the customer record was created.

formatdate-time

Email string

The customer's email address.

formatemail

Name string

Full name of the individual or business name.

Phone string

The customer's phone number in E.164 format.

Status string

One of the following:

const CustomerUnmaskedV1DataStatusPending CustomerUnmaskedV1DataStatus = "pending"

const CustomerUnmaskedV1DataStatusReview CustomerUnmaskedV1DataStatus = "review"

const CustomerUnmaskedV1DataStatusVerified CustomerUnmaskedV1DataStatus = "verified"

const CustomerUnmaskedV1DataStatusInactive CustomerUnmaskedV1DataStatus = "inactive"

const CustomerUnmaskedV1DataStatusRejected CustomerUnmaskedV1DataStatus = "rejected"

Type string

One of the following:

const CustomerUnmaskedV1DataTypeIndividual CustomerUnmaskedV1DataType = "individual"

const CustomerUnmaskedV1DataTypeBusiness CustomerUnmaskedV1DataType = "business"

UpdatedAt Time

Timestamp of the most recent update to the customer record.

formatdate-time

Address CustomerAddressV1optional

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).

maxLength100

City string

City, district, suburb, town, or village.

maxLength100

State string

Two-letter state code.

Zip string

Zip or postal code.

Address2 stringoptional

Secondary address line (e.g., apartment, suite, unit, or building).

maxLength100

ComplianceProfile CustomerUnmaskedV1DataComplianceProfileUnionoptional

Individual PII data required to trigger Patriot Act compliant KYC verification.

One of the following:

type CustomerUnmaskedV1DataComplianceProfileIndividualComplianceProfile struct{…}

Individual PII data required to trigger Patriot Act compliant KYC verification.

Dob Time

Date of birth (YYYY-MM-DD). Required for Patriot Act-compliant KYC verification.

formatdate

Ssn string

Social Security Number (format XXX-XX-XXXX). Required for Patriot Act-compliant KYC verification.

type CustomerUnmaskedV1DataComplianceProfileBusinessComplianceProfile struct{…}

Business registration data required to trigger Patriot Act compliant KYB verification.

Ein string

Employer Identification Number (format XX-XXXXXXX). Required for Patriot Act-compliant KYB verification.

LegalBusinessName string

Official registered business name as listed with the IRS. This value will be matched against the 'legal_business name'.

Representatives []CustomerUnmaskedV1DataComplianceProfileBusinessComplianceProfileRepresentativeoptional

A list of people related to the company. Only valid where customer type is 'business'.

Name string

Email stringoptional

Phone stringoptional

Website stringoptional

Official business website URL. Optional but recommended for enhanced KYB.

formaturi

Config CustomerUnmaskedV1DataConfigoptional

ProcessingMethod stringoptional

One of the following:

const CustomerUnmaskedV1DataConfigProcessingMethodInline CustomerUnmaskedV1DataConfigProcessingMethod = "inline"

const CustomerUnmaskedV1DataConfigProcessingMethodBackground CustomerUnmaskedV1DataConfigProcessingMethod = "background"

const CustomerUnmaskedV1DataConfigProcessingMethodSkip CustomerUnmaskedV1DataConfigProcessingMethod = "skip"

SandboxOutcome stringoptional

One of the following:

const CustomerUnmaskedV1DataConfigSandboxOutcomeStandard CustomerUnmaskedV1DataConfigSandboxOutcome = "standard"

const CustomerUnmaskedV1DataConfigSandboxOutcomeVerified CustomerUnmaskedV1DataConfigSandboxOutcome = "verified"

const CustomerUnmaskedV1DataConfigSandboxOutcomeRejected CustomerUnmaskedV1DataConfigSandboxOutcome = "rejected"

const CustomerUnmaskedV1DataConfigSandboxOutcomeReview CustomerUnmaskedV1DataConfigSandboxOutcome = "review"

Device DeviceUnmaskedV1optional

IPAddress string

The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.

minLength1

formatipv4

ExternalID stringoptional

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

Metadata map[string, string]optional

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.

Meta ResponseMetadata

Metadata about the API request, including an identifier and timestamp.

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

ResponseType CustomerUnmaskedV1ResponseType

Indicates the structure of the returned content.

"object" means the data field contains a single JSON object.
"array" means the data field contains an array of objects.
"error" means the data field contains an error object with details of the issue.
"none" means no data is returned.

One of the following:

const CustomerUnmaskedV1ResponseTypeObject CustomerUnmaskedV1ResponseType = "object"

const CustomerUnmaskedV1ResponseTypeArray CustomerUnmaskedV1ResponseType = "array"

const CustomerUnmaskedV1ResponseTypeError CustomerUnmaskedV1ResponseType = "error"

const CustomerUnmaskedV1ResponseTypeNone CustomerUnmaskedV1ResponseType = "none"

type CustomerV1 struct{…}

Data CustomerV1Data

ID string

Unique identifier for the customer.

formatuuid

CreatedAt Time

Timestamp of when the customer record was created.

formatdate-time

Email string

The customer's email address.

formatemail

Name string

Full name of the individual or business name.

Phone string

The customer's phone number in E.164 format.

Status string

One of the following:

const CustomerV1DataStatusPending CustomerV1DataStatus = "pending"

const CustomerV1DataStatusReview CustomerV1DataStatus = "review"

const CustomerV1DataStatusVerified CustomerV1DataStatus = "verified"

const CustomerV1DataStatusInactive CustomerV1DataStatus = "inactive"

const CustomerV1DataStatusRejected CustomerV1DataStatus = "rejected"

Type string

One of the following:

const CustomerV1DataTypeIndividual CustomerV1DataType = "individual"

const CustomerV1DataTypeBusiness CustomerV1DataType = "business"

UpdatedAt Time

Timestamp of the most recent update to the customer record.

formatdate-time

Address CustomerAddressV1optional

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).

maxLength100

City string

City, district, suburb, town, or village.

maxLength100

State string

Two-letter state code.

Zip string

Zip or postal code.

Address2 stringoptional

Secondary address line (e.g., apartment, suite, unit, or building).

maxLength100

ComplianceProfile CustomerV1DataComplianceProfileUnionoptional

PII required to trigger Patriot Act compliant KYC verification.

One of the following:

type CustomerV1DataComplianceProfileIndividualComplianceProfile struct{…}

PII required to trigger Patriot Act compliant KYC verification.

Dob Time

Masked date of birth in ****-- format.

formatdate

Ssn string

Masked Social Security Number in the format --***.

type CustomerV1DataComplianceProfileBusinessComplianceProfile struct{…}

Business registration data required to trigger Patriot Act compliant KYB verification.

Ein string

Masked Employer Identification Number in the format -*****

LegalBusinessName string

The official registered name of the business. This name should be correlated with the ein value.

Representatives []CustomerV1DataComplianceProfileBusinessComplianceProfileRepresentativeoptional

A list of people related to the company. Only valid where customer type is 'business'.

Name string

Email stringoptional

Phone stringoptional

Website stringoptional

Official business website URL. Optional but recommended for enhanced KYB.

formaturi

Config CustomerV1DataConfigoptional

ProcessingMethod stringoptional

One of the following:

const CustomerV1DataConfigProcessingMethodInline CustomerV1DataConfigProcessingMethod = "inline"

const CustomerV1DataConfigProcessingMethodBackground CustomerV1DataConfigProcessingMethod = "background"

const CustomerV1DataConfigProcessingMethodSkip CustomerV1DataConfigProcessingMethod = "skip"

SandboxOutcome stringoptional

One of the following:

const CustomerV1DataConfigSandboxOutcomeStandard CustomerV1DataConfigSandboxOutcome = "standard"

const CustomerV1DataConfigSandboxOutcomeVerified CustomerV1DataConfigSandboxOutcome = "verified"

const CustomerV1DataConfigSandboxOutcomeRejected CustomerV1DataConfigSandboxOutcome = "rejected"

const CustomerV1DataConfigSandboxOutcomeReview CustomerV1DataConfigSandboxOutcome = "review"

Device CustomerV1DataDeviceoptional

IPAddress string

The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.

minLength1

formatipv4

ExternalID stringoptional

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

Metadata map[string, string]optional

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.

Meta ResponseMetadata

Metadata about the API request, including an identifier and timestamp.

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

ResponseType CustomerV1ResponseType

Indicates the structure of the returned content.

"object" means the data field contains a single JSON object.
"array" means the data field contains an array of objects.
"error" means the data field contains an error object with details of the issue.
"none" means no data is returned.

One of the following:

const CustomerV1ResponseTypeObject CustomerV1ResponseType = "object"

const CustomerV1ResponseTypeArray CustomerV1ResponseType = "array"

const CustomerV1ResponseTypeError CustomerV1ResponseType = "error"

const CustomerV1ResponseTypeNone CustomerV1ResponseType = "none"

type DeviceUnmaskedV1 struct{…}

IPAddress string

The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.

minLength1

formatipv4

CustomersReview

Review a customer's identity results

client.Customers.Review.Get(ctx, id, query) (*CustomerReviewV1, error)

GET/v1/customers/{id}/review

Update a customer's verification status

client.Customers.Review.Decision(ctx, id, params) (*CustomerV1, error)

PATCH/v1/customers/{id}/review

Update a customer's identity decision

client.Customers.Review.RefreshReview(ctx, id, body) (*CustomerV1, error)

PUT/v1/customers/{id}/refresh_review

ModelsExpand Collapse

type CustomerReviewV1 struct{…}

Data CustomerReviewV1Data

CustomerDetails CustomerReviewV1DataCustomerDetails

ID string

Unique identifier for the customer.

formatuuid

CreatedAt Time

Timestamp of when the customer record was created.

formatdate-time

Email string

The customer's email address.

formatemail

Name string

Full name of the individual or business name.

Phone string

The customer's phone number in E.164 format.

Status string

One of the following:

const CustomerReviewV1DataCustomerDetailsStatusPending CustomerReviewV1DataCustomerDetailsStatus = "pending"

const CustomerReviewV1DataCustomerDetailsStatusReview CustomerReviewV1DataCustomerDetailsStatus = "review"

const CustomerReviewV1DataCustomerDetailsStatusVerified CustomerReviewV1DataCustomerDetailsStatus = "verified"

const CustomerReviewV1DataCustomerDetailsStatusInactive CustomerReviewV1DataCustomerDetailsStatus = "inactive"

const CustomerReviewV1DataCustomerDetailsStatusRejected CustomerReviewV1DataCustomerDetailsStatus = "rejected"

Type string

One of the following:

const CustomerReviewV1DataCustomerDetailsTypeIndividual CustomerReviewV1DataCustomerDetailsType = "individual"

const CustomerReviewV1DataCustomerDetailsTypeBusiness CustomerReviewV1DataCustomerDetailsType = "business"

UpdatedAt Time

Timestamp of the most recent update to the customer record.

formatdate-time

Address CustomerAddressV1optional

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).

maxLength100

City string

City, district, suburb, town, or village.

maxLength100

State string

Two-letter state code.

Zip string

Zip or postal code.

Address2 stringoptional

Secondary address line (e.g., apartment, suite, unit, or building).

maxLength100

ComplianceProfile CustomerReviewV1DataCustomerDetailsComplianceProfileUnionoptional

PII required to trigger Patriot Act compliant KYC verification.

One of the following:

type CustomerReviewV1DataCustomerDetailsComplianceProfileIndividualComplianceProfile struct{…}

PII required to trigger Patriot Act compliant KYC verification.

Dob Time

Masked date of birth in ****-- format.

formatdate

Ssn string

Masked Social Security Number in the format --***.

type CustomerReviewV1DataCustomerDetailsComplianceProfileBusinessComplianceProfile struct{…}

Business registration data required to trigger Patriot Act compliant KYB verification.

Ein string

Masked Employer Identification Number in the format -*****

LegalBusinessName string

The official registered name of the business. This name should be correlated with the ein value.

Representatives []CustomerReviewV1DataCustomerDetailsComplianceProfileBusinessComplianceProfileRepresentativeoptional

A list of people related to the company. Only valid where customer type is 'business'.

Name string

Email stringoptional

Phone stringoptional

Website stringoptional

Official business website URL. Optional but recommended for enhanced KYB.

formaturi

Config CustomerReviewV1DataCustomerDetailsConfigoptional

ProcessingMethod stringoptional

One of the following:

const CustomerReviewV1DataCustomerDetailsConfigProcessingMethodInline CustomerReviewV1DataCustomerDetailsConfigProcessingMethod = "inline"

const CustomerReviewV1DataCustomerDetailsConfigProcessingMethodBackground CustomerReviewV1DataCustomerDetailsConfigProcessingMethod = "background"

const CustomerReviewV1DataCustomerDetailsConfigProcessingMethodSkip CustomerReviewV1DataCustomerDetailsConfigProcessingMethod = "skip"

SandboxOutcome stringoptional

One of the following:

const CustomerReviewV1DataCustomerDetailsConfigSandboxOutcomeStandard CustomerReviewV1DataCustomerDetailsConfigSandboxOutcome = "standard"

const CustomerReviewV1DataCustomerDetailsConfigSandboxOutcomeVerified CustomerReviewV1DataCustomerDetailsConfigSandboxOutcome = "verified"

const CustomerReviewV1DataCustomerDetailsConfigSandboxOutcomeRejected CustomerReviewV1DataCustomerDetailsConfigSandboxOutcome = "rejected"

const CustomerReviewV1DataCustomerDetailsConfigSandboxOutcomeReview CustomerReviewV1DataCustomerDetailsConfigSandboxOutcome = "review"

Device CustomerReviewV1DataCustomerDetailsDeviceoptional

IPAddress string

The customer's IP address at the time of profile creation. Use 0.0.0.0 to represent an offline customer registration.

minLength1

formatipv4

ExternalID stringoptional

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

Metadata map[string, string]optional

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the customer in a structured format.

IdentityDetails CustomerReviewV1DataIdentityDetailsoptional

Breakdown CustomerReviewV1DataIdentityDetailsBreakdown

Detailed breakdown of the customer verification results, including decisions, risk scores, correlation score, and more.

Address IdentityVerificationBreakdownV1optional

Codes []stringoptional

List of specific result codes from the fraud and risk screening.

Correlation IdentityVerificationBreakdownV1Correlationoptional

One of the following:

const IdentityVerificationBreakdownV1CorrelationLowConfidence IdentityVerificationBreakdownV1Correlation = "low_confidence"

const IdentityVerificationBreakdownV1CorrelationPotentialMatch IdentityVerificationBreakdownV1Correlation = "potential_match"

const IdentityVerificationBreakdownV1CorrelationLikelyMatch IdentityVerificationBreakdownV1Correlation = "likely_match"

const IdentityVerificationBreakdownV1CorrelationHighConfidence IdentityVerificationBreakdownV1Correlation = "high_confidence"

CorrelationScore float64optional

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

Decision IdentityVerificationBreakdownV1Decisionoptional

One of the following:

const IdentityVerificationBreakdownV1DecisionAccept IdentityVerificationBreakdownV1Decision = "accept"

const IdentityVerificationBreakdownV1DecisionReject IdentityVerificationBreakdownV1Decision = "reject"

const IdentityVerificationBreakdownV1DecisionReview IdentityVerificationBreakdownV1Decision = "review"

RiskScore float64optional

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

BusinessEvaluation IdentityVerificationBreakdownV1optional

Codes []stringoptional

List of specific result codes from the fraud and risk screening.

Correlation IdentityVerificationBreakdownV1Correlationoptional

One of the following:

const IdentityVerificationBreakdownV1CorrelationLowConfidence IdentityVerificationBreakdownV1Correlation = "low_confidence"

const IdentityVerificationBreakdownV1CorrelationPotentialMatch IdentityVerificationBreakdownV1Correlation = "potential_match"

const IdentityVerificationBreakdownV1CorrelationLikelyMatch IdentityVerificationBreakdownV1Correlation = "likely_match"

const IdentityVerificationBreakdownV1CorrelationHighConfidence IdentityVerificationBreakdownV1Correlation = "high_confidence"

CorrelationScore float64optional

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

Decision IdentityVerificationBreakdownV1Decisionoptional

One of the following:

const IdentityVerificationBreakdownV1DecisionAccept IdentityVerificationBreakdownV1Decision = "accept"

const IdentityVerificationBreakdownV1DecisionReject IdentityVerificationBreakdownV1Decision = "reject"

const IdentityVerificationBreakdownV1DecisionReview IdentityVerificationBreakdownV1Decision = "review"

RiskScore float64optional

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

BusinessIdentification IdentityVerificationBreakdownV1optional

Codes []stringoptional

List of specific result codes from the fraud and risk screening.

Correlation IdentityVerificationBreakdownV1Correlationoptional

One of the following:

const IdentityVerificationBreakdownV1CorrelationLowConfidence IdentityVerificationBreakdownV1Correlation = "low_confidence"

const IdentityVerificationBreakdownV1CorrelationPotentialMatch IdentityVerificationBreakdownV1Correlation = "potential_match"

const IdentityVerificationBreakdownV1CorrelationLikelyMatch IdentityVerificationBreakdownV1Correlation = "likely_match"

const IdentityVerificationBreakdownV1CorrelationHighConfidence IdentityVerificationBreakdownV1Correlation = "high_confidence"

CorrelationScore float64optional

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

Decision IdentityVerificationBreakdownV1Decisionoptional

One of the following:

const IdentityVerificationBreakdownV1DecisionAccept IdentityVerificationBreakdownV1Decision = "accept"

const IdentityVerificationBreakdownV1DecisionReject IdentityVerificationBreakdownV1Decision = "reject"

const IdentityVerificationBreakdownV1DecisionReview IdentityVerificationBreakdownV1Decision = "review"

RiskScore float64optional

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

BusinessValidation IdentityVerificationBreakdownV1optional

Codes []stringoptional

List of specific result codes from the fraud and risk screening.

Correlation IdentityVerificationBreakdownV1Correlationoptional

One of the following:

const IdentityVerificationBreakdownV1CorrelationLowConfidence IdentityVerificationBreakdownV1Correlation = "low_confidence"

const IdentityVerificationBreakdownV1CorrelationPotentialMatch IdentityVerificationBreakdownV1Correlation = "potential_match"

const IdentityVerificationBreakdownV1CorrelationLikelyMatch IdentityVerificationBreakdownV1Correlation = "likely_match"

const IdentityVerificationBreakdownV1CorrelationHighConfidence IdentityVerificationBreakdownV1Correlation = "high_confidence"

CorrelationScore float64optional

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

Decision IdentityVerificationBreakdownV1Decisionoptional

One of the following:

const IdentityVerificationBreakdownV1DecisionAccept IdentityVerificationBreakdownV1Decision = "accept"

const IdentityVerificationBreakdownV1DecisionReject IdentityVerificationBreakdownV1Decision = "reject"

const IdentityVerificationBreakdownV1DecisionReview IdentityVerificationBreakdownV1Decision = "review"

RiskScore float64optional

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

Email IdentityVerificationBreakdownV1optional

Codes []stringoptional

List of specific result codes from the fraud and risk screening.

Correlation IdentityVerificationBreakdownV1Correlationoptional

One of the following:

const IdentityVerificationBreakdownV1CorrelationLowConfidence IdentityVerificationBreakdownV1Correlation = "low_confidence"

const IdentityVerificationBreakdownV1CorrelationPotentialMatch IdentityVerificationBreakdownV1Correlation = "potential_match"

const IdentityVerificationBreakdownV1CorrelationLikelyMatch IdentityVerificationBreakdownV1Correlation = "likely_match"

const IdentityVerificationBreakdownV1CorrelationHighConfidence IdentityVerificationBreakdownV1Correlation = "high_confidence"

CorrelationScore float64optional

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

Decision IdentityVerificationBreakdownV1Decisionoptional

One of the following:

const IdentityVerificationBreakdownV1DecisionAccept IdentityVerificationBreakdownV1Decision = "accept"

const IdentityVerificationBreakdownV1DecisionReject IdentityVerificationBreakdownV1Decision = "reject"

const IdentityVerificationBreakdownV1DecisionReview IdentityVerificationBreakdownV1Decision = "review"

RiskScore float64optional

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

Fraud IdentityVerificationBreakdownV1optional

Codes []stringoptional

List of specific result codes from the fraud and risk screening.

Correlation IdentityVerificationBreakdownV1Correlationoptional

One of the following:

const IdentityVerificationBreakdownV1CorrelationLowConfidence IdentityVerificationBreakdownV1Correlation = "low_confidence"

const IdentityVerificationBreakdownV1CorrelationPotentialMatch IdentityVerificationBreakdownV1Correlation = "potential_match"

const IdentityVerificationBreakdownV1CorrelationLikelyMatch IdentityVerificationBreakdownV1Correlation = "likely_match"

const IdentityVerificationBreakdownV1CorrelationHighConfidence IdentityVerificationBreakdownV1Correlation = "high_confidence"

CorrelationScore float64optional

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

Decision IdentityVerificationBreakdownV1Decisionoptional

One of the following:

const IdentityVerificationBreakdownV1DecisionAccept IdentityVerificationBreakdownV1Decision = "accept"

const IdentityVerificationBreakdownV1DecisionReject IdentityVerificationBreakdownV1Decision = "reject"

const IdentityVerificationBreakdownV1DecisionReview IdentityVerificationBreakdownV1Decision = "review"

RiskScore float64optional

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

Phone IdentityVerificationBreakdownV1optional

Codes []stringoptional

List of specific result codes from the fraud and risk screening.

Correlation IdentityVerificationBreakdownV1Correlationoptional

One of the following:

const IdentityVerificationBreakdownV1CorrelationLowConfidence IdentityVerificationBreakdownV1Correlation = "low_confidence"

const IdentityVerificationBreakdownV1CorrelationPotentialMatch IdentityVerificationBreakdownV1Correlation = "potential_match"

const IdentityVerificationBreakdownV1CorrelationLikelyMatch IdentityVerificationBreakdownV1Correlation = "likely_match"

const IdentityVerificationBreakdownV1CorrelationHighConfidence IdentityVerificationBreakdownV1Correlation = "high_confidence"

CorrelationScore float64optional

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

Decision IdentityVerificationBreakdownV1Decisionoptional

One of the following:

const IdentityVerificationBreakdownV1DecisionAccept IdentityVerificationBreakdownV1Decision = "accept"

const IdentityVerificationBreakdownV1DecisionReject IdentityVerificationBreakdownV1Decision = "reject"

const IdentityVerificationBreakdownV1DecisionReview IdentityVerificationBreakdownV1Decision = "review"

RiskScore float64optional

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

Synthetic IdentityVerificationBreakdownV1optional

Codes []stringoptional

List of specific result codes from the fraud and risk screening.

Correlation IdentityVerificationBreakdownV1Correlationoptional

One of the following:

const IdentityVerificationBreakdownV1CorrelationLowConfidence IdentityVerificationBreakdownV1Correlation = "low_confidence"

const IdentityVerificationBreakdownV1CorrelationPotentialMatch IdentityVerificationBreakdownV1Correlation = "potential_match"

const IdentityVerificationBreakdownV1CorrelationLikelyMatch IdentityVerificationBreakdownV1Correlation = "likely_match"

const IdentityVerificationBreakdownV1CorrelationHighConfidence IdentityVerificationBreakdownV1Correlation = "high_confidence"

CorrelationScore float64optional

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

Decision IdentityVerificationBreakdownV1Decisionoptional

One of the following:

const IdentityVerificationBreakdownV1DecisionAccept IdentityVerificationBreakdownV1Decision = "accept"

const IdentityVerificationBreakdownV1DecisionReject IdentityVerificationBreakdownV1Decision = "reject"

const IdentityVerificationBreakdownV1DecisionReview IdentityVerificationBreakdownV1Decision = "review"

RiskScore float64optional

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble

CreatedAt Time

Timestamp of when the review was initiated.

formatdate-time

Decision string

One of the following:

const CustomerReviewV1DataIdentityDetailsDecisionAccept CustomerReviewV1DataIdentityDetailsDecision = "accept"

const CustomerReviewV1DataIdentityDetailsDecisionReject CustomerReviewV1DataIdentityDetailsDecision = "reject"

const CustomerReviewV1DataIdentityDetailsDecisionReview CustomerReviewV1DataIdentityDetailsDecision = "review"

ReviewID string

Unique identifier for the review.

formatuuid

UpdatedAt Time

Timestamp of the most recent update to the review.

formatdate-time

KYC CustomerReviewV1DataIdentityDetailsKYCoptional

Validations CustomerReviewV1DataIdentityDetailsKYCValidations

Boolean values indicating the result of each validation in the KYC process.

Address booloptional

City booloptional

Dob booloptional

Email booloptional

FirstName booloptional

LastName booloptional

Phone booloptional

Ssn booloptional

State booloptional

Zip booloptional

Codes []stringoptional

List of specific result codes from the KYC screening process.

Decision stringoptional

One of the following:

const CustomerReviewV1DataIdentityDetailsKYCDecisionAccept CustomerReviewV1DataIdentityDetailsKYCDecision = "accept"

const CustomerReviewV1DataIdentityDetailsKYCDecisionReject CustomerReviewV1DataIdentityDetailsKYCDecision = "reject"

const CustomerReviewV1DataIdentityDetailsKYCDecisionReview CustomerReviewV1DataIdentityDetailsKYCDecision = "review"

Messages map[string, string]optional

Dictionary of all messages from the customer verification process.

NetworkAlerts CustomerReviewV1DataIdentityDetailsNetworkAlertsoptional

Alerts []stringoptional

Any alerts or flags raised during the consortium alert screening.

Codes []stringoptional

List of specific result codes from the consortium alert screening.

Decision stringoptional

One of the following:

const CustomerReviewV1DataIdentityDetailsNetworkAlertsDecisionAccept CustomerReviewV1DataIdentityDetailsNetworkAlertsDecision = "accept"

const CustomerReviewV1DataIdentityDetailsNetworkAlertsDecisionReject CustomerReviewV1DataIdentityDetailsNetworkAlertsDecision = "reject"

const CustomerReviewV1DataIdentityDetailsNetworkAlertsDecisionReview CustomerReviewV1DataIdentityDetailsNetworkAlertsDecision = "review"

Reputation CustomerReviewV1DataIdentityDetailsReputationoptional

Codes []stringoptional

Specific codes related to the Straddle reputation screening results.

Decision stringoptional

One of the following:

const CustomerReviewV1DataIdentityDetailsReputationDecisionAccept CustomerReviewV1DataIdentityDetailsReputationDecision = "accept"

const CustomerReviewV1DataIdentityDetailsReputationDecisionReject CustomerReviewV1DataIdentityDetailsReputationDecision = "reject"

const CustomerReviewV1DataIdentityDetailsReputationDecisionReview CustomerReviewV1DataIdentityDetailsReputationDecision = "review"

Insights CustomerReviewV1DataIdentityDetailsReputationInsightsoptional

AccountsActiveCount int64optional

AccountsClosedCount int64optional

AccountsClosedDates []Timeoptional

AccountsCount int64optional

AccountsFraudCount int64optional

AccountsFraudLabeledDates []Timeoptional

AccountsFraudLossTotalAmount float64optional

ACHFraudTransactionsCount int64optional

ACHFraudTransactionsDates []Timeoptional

ACHFraudTransactionsTotalAmount float64optional

ACHReturnedTransactionsCount int64optional

ACHReturnedTransactionsDates []Timeoptional

ACHReturnedTransactionsTotalAmount float64optional

ApplicationsApprovedCount int64optional

ApplicationsCount int64optional

ApplicationsDates []Timeoptional

ApplicationsDeclinedCount int64optional

ApplicationsFraudCount int64optional

CardDisputedTransactionsCount int64optional

CardDisputedTransactionsDates []Timeoptional

CardDisputedTransactionsTotalAmount float64optional

CardFraudTransactionsCount int64optional

CardFraudTransactionsDates []Timeoptional

CardFraudTransactionsTotalAmount float64optional

CardStoppedTransactionsCount int64optional

CardStoppedTransactionsDates []Timeoptional

UserActiveProfileCount int64optional

UserAddressCount int64optional

UserClosedProfileCount int64optional

UserDobCount int64optional

UserEmailCount int64optional

UserInstitutionCount int64optional

UserMobileCount int64optional

RiskScore float64optional

WatchList CustomerReviewV1DataIdentityDetailsWatchListoptional

Codes []stringoptional

Specific codes related to the Straddle watchlist screening results.

Decision stringoptional

One of the following:

const CustomerReviewV1DataIdentityDetailsWatchListDecisionAccept CustomerReviewV1DataIdentityDetailsWatchListDecision = "accept"

const CustomerReviewV1DataIdentityDetailsWatchListDecisionReject CustomerReviewV1DataIdentityDetailsWatchListDecision = "reject"

const CustomerReviewV1DataIdentityDetailsWatchListDecisionReview CustomerReviewV1DataIdentityDetailsWatchListDecision = "review"

Matched []stringoptional

Information about any matches found during screening.

Matches []CustomerReviewV1DataIdentityDetailsWatchListMatchoptional

Information about any matches found during screening.

Correlation string

One of the following:

const CustomerReviewV1DataIdentityDetailsWatchListMatchCorrelationLowConfidence CustomerReviewV1DataIdentityDetailsWatchListMatchCorrelation = "low_confidence"

const CustomerReviewV1DataIdentityDetailsWatchListMatchCorrelationPotentialMatch CustomerReviewV1DataIdentityDetailsWatchListMatchCorrelation = "potential_match"

const CustomerReviewV1DataIdentityDetailsWatchListMatchCorrelationLikelyMatch CustomerReviewV1DataIdentityDetailsWatchListMatchCorrelation = "likely_match"

const CustomerReviewV1DataIdentityDetailsWatchListMatchCorrelationHighConfidence CustomerReviewV1DataIdentityDetailsWatchListMatchCorrelation = "high_confidence"

ListName string

The name of the list the match was found.

MatchFields []string

Data fields that matched.

URLs []string

Relevent Urls to review.

Meta ResponseMetadata

Metadata about the API request, including an identifier and timestamp.

APIRequestID string

Unique identifier for this API request, useful for troubleshooting.

formatuuid

APIRequestTimestamp Time

Timestamp for this API request, useful for troubleshooting.

formatdate-time

ResponseType CustomerReviewV1ResponseType

Indicates the structure of the returned content.

"object" means the data field contains a single JSON object.
"array" means the data field contains an array of objects.
"error" means the data field contains an error object with details of the issue.
"none" means no data is returned.

One of the following:

const CustomerReviewV1ResponseTypeObject CustomerReviewV1ResponseType = "object"

const CustomerReviewV1ResponseTypeArray CustomerReviewV1ResponseType = "array"

const CustomerReviewV1ResponseTypeError CustomerReviewV1ResponseType = "error"

const CustomerReviewV1ResponseTypeNone CustomerReviewV1ResponseType = "none"

type IdentityVerificationBreakdownV1 struct{…}

Codes []stringoptional

List of specific result codes from the fraud and risk screening.

Correlation IdentityVerificationBreakdownV1Correlationoptional

One of the following:

const IdentityVerificationBreakdownV1CorrelationLowConfidence IdentityVerificationBreakdownV1Correlation = "low_confidence"

const IdentityVerificationBreakdownV1CorrelationPotentialMatch IdentityVerificationBreakdownV1Correlation = "potential_match"

const IdentityVerificationBreakdownV1CorrelationLikelyMatch IdentityVerificationBreakdownV1Correlation = "likely_match"

const IdentityVerificationBreakdownV1CorrelationHighConfidence IdentityVerificationBreakdownV1Correlation = "high_confidence"

CorrelationScore float64optional

Represents the strength of the correlation between provided and known information. A higher score indicates a stronger correlation.

formatdouble

Decision IdentityVerificationBreakdownV1Decisionoptional

One of the following:

const IdentityVerificationBreakdownV1DecisionAccept IdentityVerificationBreakdownV1Decision = "accept"

const IdentityVerificationBreakdownV1DecisionReject IdentityVerificationBreakdownV1Decision = "reject"

const IdentityVerificationBreakdownV1DecisionReview IdentityVerificationBreakdownV1Decision = "review"

RiskScore float64optional

Predicts the inherent risk associated with the customer for a given module. A higher score indicates a greater likelihood of fraud.

formatdouble