Search Accounts

post

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

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 CST search provides.

Try Get Account by ID 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

Status codes

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

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"

accountNo

string | null

^$|^([0-9]{12}|[0-9]{16})$

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

firstName

string | null

1 to 40

Account holder's first name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "Ed"

middleName

string | null

1 to 40

Account holder's middle name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "W"

lastName

string | null

1 to 40

Account holder's last name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "Harley"

dateOfBirth

date | null

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"

postalCode

string | null

5 to 10

^[a-zA-Z0-9\-\ ]*$

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

primaryPhone

string | null

10 to 10

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"

otherPhone

string | null

10 to 10

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"

mobilePhone

string | null

10 to 10

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"

string | null

Account holder's email. This field is validated by Marshmallow.
Pattern: Email address, 3–63 characters
Example: "[email protected]"

userData

string | null

^[a-zA-Z0-9_ ]*$

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 RDF.
Pattern: Max 50 alphanumeric characters, underscores and spaces
Example: "a4434gg44"

eextid

string | null

≤ 30

^[a-zA-Z0-9\-]*$

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

recordCnt

int32 | null

10 to 100

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

page

int32

1 to 100

Defaults to 1

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

mobilePhoneCountryCode

string | null

2 to 4

^\+[0-9]*$

Account holder's mobile phone country code.
Pattern: A plus sign followed by 1–3 digits. See Phone Validation for valid values.
Example: "+1"

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