Accounts and Cards

Verify Enrollment

Use the Verify Enrollment endpoint to look up an existing enrollment by transactionId or id to view information and status. The endpoint returns enrollment data, enrollment date, and transactionID of the initial enrollment, when the enrollment was initiated with the <a href="ref:post_startenrollment" target="_blank">Start Enrollment</a> or <a href="ref:post_createaccount" target="_blank">Create Account</a> endpoint.

post/verifyEnrollment

Request

Base URL
api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
URL
api-{corename}.{env}.gpsrv.com/intserv/4.0/verifyEnrollment
Auth
none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

idstring nullable

The value of the primary identifier that is specified in idType. Product settings determine whether this ID should be unique across the program or product. This parameter is required when using the SoFi Tech Solutions legacy <glossary:CIP> solution. The system converts all letters to lowercase. Pattern: As specified in the Layout column of the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> enumeration Example: "123456789"

idType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 nullable

Specifies the type of primary identifier in the id parameter. This parameter is required when id is populated. See the idType column in the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> table for valid values. Pattern: Integer Example: 2

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123456789",
  "idType": 2
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes

No recorded changes to this operation across all 2 revisions of this API.