Verify Enrollment

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/verifyEnrollment

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 Start Enrollment or Create Account endpoint.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
505-01	Enrollment record could not be found

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

int32

required

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

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

string | null

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 CIP solution. The system converts all letters to lowercase.
Pattern: As specified in the Layout column of the Customer ID Types enumeration
Example: "123456789"

idType

int32 | null

enum

Specifies the type of primary identifier in the id parameter. This parameter is required when id is populated. See the idType column in the Customer ID Types table for valid values.
Pattern: Integer
Example: 2

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default