Get Account by ID

post

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

Use the Get Account by ID endpoint to retrieve account information using exactly one of the mutually exclusive lookup keys. See Account lookup for specific instructions.

This endpoint returns customer data such as enrollment status and onboarding date as well as a list of all accounts associated with the customer. Each account entry includes closureDate to indicate when the account was closed. closureDate is populated only when the account is in status C (closed/canceled), Z (closed/canceled without refund), or R (charged off); it is null for open accounts.

To search on broader criteria, try Search Accounts.

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"

string | null

Unique identifier for an account holder. This is the primary id that was passed in an enrollment endpoint request during account creation. The system converts all letters to lowercase.
Pattern: See Customer ID Types
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 ID column in the Customer ID Types table for valid values.
Pattern: 1- or 2-digit integer
Example: 2

externalCustomerId

string | null

≤ 512

User-supplied identifier that is related to an external system.
Pattern: Max 512 characters: all ASCII characters
Example: "acv#-@45!sbsxm%-"

customerId

int32 | null

≥ 1

Galileo's internal, unique customer identifier, called client_id in the code. This is a deterministic 1:1 lookup key for a single customer. When provided, the response includes the customer's externalCustomerId.
Pattern: Positive integer
Example: 123456789

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