Accounts and Cards

Search Accounts

Use the Search Accounts endpoint to find a customer account by passing at least one of the parameters. The data in the response is similar to what the <glossary:CST> search provides.

Try <a href="ref:post_getaccountbyid" target="_blank">Get Account by ID</a> to specify a customer identifier and retrieve all associated accounts.

For the recordCnt parameter use these values to get the desired number of records per page:

No value — 50 records per page
1 through 100 — The specified number of records per page
Values over 100 — 100 records per page

post/searchAccounts

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/searchAccounts
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"

accountNostring nullable

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

firstNamestring nullable

Account holder's first name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Ed"

middleNamestring nullable

Account holder's middle name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "W"

lastNamestring nullable

Account holder's last name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Harley"

dateOfBirthstring date nullable

Account holder's birth date. This date is compared with the DOB product parameter when there is a minimum age requirement on the account. Pattern: YYYY-MM-DD Example: "1980-01-01"

postalCodestring nullable

Account holder's postal code (ZIP code). Pattern: 12345, 12345-1234, or K1A-1A1 Example: "84121"

primaryPhonestring nullable

Account holder's primary phone number. When passing a value for this parameter, you must also pass mobilePhoneCountryCode. Pattern: Validation according to the value in mobilePhoneCountryCode. Example: "8013656050"

otherPhonestring nullable

Account holder's secondary phone number. When passing a value for this parameter, you must also pass mobilePhoneCountryCode. Pattern: Validation according to the value in mobilePhoneCountryCode. Example: "8013656050"

mobilePhonestring nullable

Account holder's mobile phone number. When passing a value for this parameter, you must also pass mobilePhoneCountryCode. Pattern: Validation according to the value in mobilePhoneCountryCode. Example: "8013656050"

emailstring email nullable

Account holder's email. This field is validated by Marshmallow. Pattern: Email address, 3–63 characters Example: "user@fakedomain.com"

userDatastring nullable

Data supplied by the provider, from sources external to the system. This data will be stored in the system in association with this account. The most common use of this parameter is to track affiliate-marketing traffic. The data in this field can be added to an <glossary:RDF>. Pattern: Max 50 alphanumeric characters, underscores and spaces Example: "a4434gg44"

eextidstring nullable

The externalAccountId that was passed in the account-creation call. Pattern: Max 30 alphanumeric characters Example: "553b45sbs"

recordCntinteger nullable

The maximum number of records per page to be returned. Pattern: Positive integer 1-99999 Example: 100

pageinteger

The number of the page to retrieve. Pattern: Integer value of 1 or greater Example: 3

mobilePhoneCountryCodestring nullable

Account holder's mobile phone country code. Pattern: A plus sign followed by 1–3 digits. See <a href="ref:api-reference-phone-validation" target="_blank">Phone Validation</a> for valid values. Example: "+1"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "firstName": "Ed",
  "middleName": "W",
  "lastName": "Harley",
  "dateOfBirth": "1980-01-01",
  "postalCode": "84121",
  "primaryPhone": "8013656050",
  "otherPhone": "8013656050",
  "mobilePhone": "8013656050",
  "email": "user@fakedomain.com",
  "userData": "a4434gg44",
  "eextid": "553b45sbs",
  "recordCnt": 100,
  "page": 3,
  "mobilePhoneCountryCode": "+1"
}

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.