Accounts and Cards

Get Account by ID

Use the Get Account by ID endpoint to retrieve account information using exactly one of the mutually exclusive lookup keys. See <a href="doc:about-accounts#account-lookup" target="_blank">Account lookup</a> 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 <a href="ref:post_searchaccounts" target="_blank">Search Accounts</a>.

post/getAccountById

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/getAccountById
  • 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

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 <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> 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 ID column in the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> table for valid values. Pattern: 1- or 2-digit integer Example: 2

externalCustomerIdstring nullable

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

customerIdinteger nullable

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

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123456789",
  "idType": 2,
  "externalCustomerId": "acv#-@45!sbsxm%-",
  "customerId": 123456789
}

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.