v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

IVS

Get Customer Status

Use the Get Customer Status endpoint to retrieve the current verification standing and final decision for a customer profile.

post/ivs/2.0/getCustomerStatus

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

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

providerIdstring required

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

ivsProfileIdstring required

The third-party provider supplies this identifier to reference the account status across other endpoints. Pattern: Numeric characters only Example: 22262843

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` or `GCORE:1:2:3

requestTsstring date-time required

The date and time when the customer status request was initiated in <a href="ref:system-time" target="_blank">our system time</a>, formatted as an ISO 8601 string. Pattern: ISO 8601 date-time (YYYY-MM-DDTHH:MM:SS) Example: 2025-01-01T00:00:00

Response

Successful Response

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.

ivsProfileIdstring required

Identifier for the IVS profile. Use this ID to reference the account's status in other endpoint requests. This identifier is supplied by the third-party provider, not SoFi Tech Solutions.

riskServiceIdstring required

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

statusstring required

Overall status of the customer's identity verification process: COMPLETE, REFERRED, AWAITING RESPONSE, PENDING EXTERNAL APPROVAL, or IN PROGRESS.

decisionstring

Final decision for identity verification. This field is returned only when the verification is complete.

systemTsstring required

Date-time when the system generated this response in <a href="ref:system-time" target="_blank">our system time</a>, formatted as an ISO 8601 string.