GAgalileo-ft
IVS

Close Application

Use the Close Application endpoint to terminate an existing identity verification application that is no longer needed.

post/ivs/2.0/closeApplication

Request

  • Base URL
    {corename}.risk.{env}.gpsrv.com
  • URL
    {corename}.risk.{env}.gpsrv.com/ivs/2.0/closeApplication
  • Auth
    none declared

Headers

authorizationstring
Example:Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5

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

X-Request-Idstring
Example:1234567890

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 closure 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

reasonIdinteger required

The reason code for closing the application:

  • 61 — Applicant requested
  • 62 — Abandoned
  • 63 — Terminated by provider

Pattern: 61, 62, or 63 Example: 61

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

Example request

{
  "entityId": "789XYZ2025",
  "requestTs": "2025-01-01T00:00:00",
  "riskServiceId": "`EPRP-test-1231231:1` or `GCORE:1:2:3`",
  "providerId": "1234567890"
}

Response

Successful Response

entityIdstring required

ID generated by you or SoFi Tech Solutions for the entity undergoing verification.

decisionstring

Final decision applied to the application upon closure: ACCEPT, DECLINE, or CLOSE.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.