v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

IVS

Close Customer Account

Use the Close Customer endpoint to terminate a customer's account and halt all associated identity-verification processes.

post/ivs/2.0/closeCustomer

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

requestTsstring date-time required

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

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

customerIdstring

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

ivsProfileIdstring

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

reasonId'61' | '62' | '63' required

The reason code for closing the application:

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

Pattern: 61, 62, or 63 Example: 61

Response

Successful Response

customerIdstring

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

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.

datestring date-time

Date-time when the customer account was officially closed.

statusstring

The condition of the customer account following the closure request: COMPLETE, REFERRED, AWAITING RESPONSE, or IN PROGRESS.

decisionstring

The final decision applied to the customer account upon closure: DECLINE or CLOSE. This field is returned only when verification is complete.

riskServiceIdstring required

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

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.