Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
IVS

Verify Customer

Use the Verify Customer endpoint to perform identity verification for individual or business customers and their associated entities. This endpoint validates customer information, including personal details, addresses, and identification documents. For businesses, a single customer profile can support the verification of multiple associated entities (e.g., directors or beneficial owners).

post/ivs/2.0/verifyCustomer

Headers

authorizationstring

Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)

X-Request-Idstring

Unique identifier for the request

Request body

providerIdstring required

The system-generated identifier for the IVS provider. Pattern: Up to 10 digits Example: "9999"

customerType'Person' | 'Business' required

Specifies the category of customer undergoing verification. Pattern: Person or Business Example: Person

customerIdstring required

ID generated by you or SoFi Tech Solutions for the top-level customer (person or business) undergoing verification. Use this to correlate this event with the specific customer record in your system. Pattern: Alphanumeric identifier Example: 789XYZ2025

eventTsstring date-time required

Timestamp for when the verification event occurred. Pattern: ISO 8601 date-time (YYYY-MM-DDTHH:MM:SS) Example: 2025-01-01T00:00:00

riskServiceIdstring required

System-generated identifier that specifies the IVS configuration strategy assigned during IVS setup. Pattern: EPRP or GCORE prefix followed by colon-separated identifiers, up to 50 characters Example: EPRP-test-1231231:1

prodIdstring required

The product ID of the account. Pattern: One or more digits Example: 9999

Response

Successful Response

ivsProfileIdinteger

The third-party provider supplies this identifier to reference the account status across other endpoints.

customerIdstring required

ID generated by you or SoFi Tech Solutions for the customer undergoing verification. Use this to correlate this event with the specific entity record in your system.

customerTypestring required

Specifies the category of customer undergoing verification: Person or Business.

riskServiceIdstring required

System-generated identifier that specifies the IVS configuration strategy assigned during IVS setup.

customerStatusstring

Overall status of the customer identity-verification process.

customerDecisionstring

Final decision for identity verification. The system returns this field only when the verification is complete.

customerVerificationResult'Pass' | 'Fail' | 'Refer' | 'In Progress'

Derived identity verification result based on the customer_status and customer_decision.