v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

IVS

Get Verification Documents

Use the Get Verification Documents endpoint to retrieve metadata and status for every document associated with a specific verification journey.

post/ivs/2.0/getVerificationDocuments

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

entityIdstring required

ID generated by you or SoFi Tech Solutions for a specific entity within a customer. For a Person customer type, this maps 1-to-1 with the customerId. For a Business customer type, a single customer may have multiple entities. Use this to correlate this event with the specific entity record in your system. Pattern: Alphanumeric identifier Example: 789XYZ2025

documentVerificationIdstring required

The unique identifier for the document-verification session. Pattern: Alphanumeric identifier Example: doc-123456

requestTsstring date-time required

The date and time when the document 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

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

providerIdstring required

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

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.

entityIdstring required

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

documentVerificationIdstring required

Unique identifier for the document-verification session.

systemTsstring date-time 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.

riskServiceIdstring required

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