v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

IVS

Get Application Status

Use the Get Application Status endpoint to retrieve the current state of an existing application, including its activity status and any pending decisions.

post/ivs/2.0/getApplicationStatus

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

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

requestTsstring date-time required

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

Unique identifier provided by SoFi Tech Solutions during IVS setup that identifies the client IVS configuration details. 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

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.

statusstring

Current status of the application: ACTIVE, CLOSED, or PENDING.

nextActionstring

The specific follow-up action required to progress the application.

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

Unique identifier provided by SoFi Tech Solutions during IVS setup that identifies the client IVS configuration details.