GAgalileo-ft
Risk

Get Instant Verification

Use the Get Instant Verification endpoint to validate the ownership and authenticity of an account. This endpoint returns risk levels, account existence, and associated metadata to help determine if an account is valid and if its owner is correctly identified. It provides detailed risk assessments for multiple use cases associated with an external bank account validation, such as <glossary:ACH> transactions, wire transactions, risk checks before account linking, and potential <glossary:AML> mitigation.

See <a href="doc:about-galileo-instant-verification-engine" target="_blank">About the Instant Verification Engine</a> for more details.

post/prp/1.0/getInstantVerification

Request

  • Base URL
    risk-{corename}.{env}.gpsrv.com/ (relative, and the document’s source URL is not known)
  • URL
    risk-{corename}.{env}.gpsrv.com/prp/1.0/getInstantVerification
  • 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"

providerIdstring required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10-digit numeric string Example: "9999"

transactionIdstring required

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

eventTsstring date-time required

Timestamp for when an event occurred. Pattern: YYYY-MM-DD hh:mm:ss Example: 2020-10-28 13:00:24

eventType'acct_vrfy' | 'ach' | 'wire' | 'rtp' | 'fednow' required

Specifies the type of an event. Pattern: acct_vrfy Example: "acct_vrfy"

eventSubtypestring

Subtype of event. Pattern: incoming_debit, outgoing_debit, incoming_credit, or outgoing_credit Example: "outgoing_credit"

instantVerifyboolean

Whether or not an event should have instant verification applied. Pattern: true or false Example: True

accountIdstring required

SoFi Tech Solutions UUID that identifies the customer account associated with the related event. Pattern: 1–120 characters Example: "a125483"

personIdstring required

Unique identifier of the customer associated with the event. Pattern: 1–120 characters Example: "p54789641"

requestTsstring date-time required

Timestamp of the account holder's request. Pattern: YYYY-MM-DD hh:mm:ss Example: 2020-10-28 13:00:24

businessNamestring

Business name of a business account. When acctType: business this field is required. Pattern: 1–120 characters Example: "Acme Financial"

firstNamestring

Account holder's first name. When acctType: personal this field is required. Pattern: 1–60 characters Example: "Ed"

middleNamestring

Account holder's middle name. Pattern: 1–60 characters Example: "W"

lastNamestring

Account holder's last name. When acctType: personal this field is required. Pattern: 1–60 characters Example: "Smith"

acctNostring required

Account holder's account number. Pattern: 5–17 digits Example: "123456789"

rtNostring required

Routing number of the account holder's bank account. Pattern: 9 digits Example: 124001545

riskServiceIdstring required

Unique identifier provided by SoFi Tech Solutions during implementation to obtain client PRP configuration details. Pattern: Up to 50 characters Example: "EPRP-test-1231231:1"

dobstring

Account holder's date of birth. Pattern: YYYY-MM-DD Example: 2024-01-01

addr1string

Account holder's first address line. Cannot be a P.O. Box. Pattern: 1–60 characters Example: "33 Maple Street"

addr2string

Account holder's second address line. Pattern: 1–60 characters Example: "APT 5520"

citystring

Account holder's city. Pattern: 1–60 characters Example: "Salt Lake City"

statestring

Account holder's state or province abbreviation. Pattern: 2 character state or province abbreviation Example: "UT"

zipstring

Account holder's postal code (ZIP code). Pattern: Up to 5 digits Example: 84121

phoneNostring

Phone number of bank account holder in E.164 format. Pattern: 1–15 digits Example: +11234567890

emailAddrstring

Account holder's email address. Pattern: 3–255 characters Example: user@example.com

acctType'personal' | 'business' | 'other'

Type of bank account. Pattern: personal, business, or other Example: "personal"

ctryCd'US'

Account holder's 2-letter ISO 3166-1 country code. Pattern: 2 uppercase letters (ISO 3166-1) Example: "US"

personCreatedTsstring date-time

Timestamp when the customer profile was created. Pattern: YYYY-MM-DD hh:mm:ss Example: 2020-10-28 13:00:24

idDocNostring

Account holder's SSN or Tax ID. Pattern: 9 digits Example: 123456789

idDocType'ssn' | 'itin' | 'ein'

Type of identification provided by the account holder. Pattern: ssn, itin, or ein Example: "ssn"

currCd'USD'

3-letter ISO-4217 currency code. Default: USD. Pattern: 3 uppercase letters (ISO 4217) Example: USD

acctSubtype'checking' | 'saving'

Account subtype of bank account holder. Pattern: checking or savings Example: "checking"

transAmtnumber

The transaction amount in the currency of the account. Pattern: 1–10 digits with 2 decimal places Example: 10000.00

partnerIdstring

System-generated partner identifier. Pattern: Up to 10-digit numeric string Example: "9999"

progIdstring

System-generated program identifier. Pattern: Up to 10-digit numeric string Example: "9999"

prodIdstring

System-generated product identifier. Pattern: Up to 10-digit numeric string Example: "9999"

balanceAmtnumber

Balance of account. Pattern: 1–10 digits with 2 decimal places Example: 450.12

balanceAsOfTsstring date-time

Timestamp balance was calculated at. Pattern: YYYY-MM-DD hh:mm:ss Example: "2020-10-28 13:00:24"

balanceReasonCdstring

Balance reason code. Pattern: success, timeout, not available, or other Example: "success"

Example request

{
  "apiLogin": "\"AbC123-9999\"",
  "apiTransKey": "\"4sb62fh6w4h7w34g\"",
  "providerId": "\"9999\"",
  "transactionId": "\"9845dk-39fdk3fj3-4483483478\"",
  "eventTs": "2020-10-28 13:00:24",
  "eventType": "\"acct_vrfy\"",
  "eventSubtype": "\"outgoing_credit\"",
  "accountId": "\"a125483\"",
  "personId": "\"p54789641\"",
  "requestTs": "2020-10-28 13:00:24",
  "businessName": "\"Acme Financial\"",
  "firstName": "\"Ed\"",
  "middleName": "\"W\"",
  "lastName": "\"Smith\"",
  "acctNo": "\"123456789\"",
  "rtNo": "124001545",
  "riskServiceId": "\"EPRP-test-1231231:1\"",
  "dob": "2024-01-01",
  "addr1": "\"33 Maple Street\"",
  "addr2": "\"APT 5520\"",
  "city": "\"Salt Lake City\"",
  "state": "\"UT\"",
  "zip": "84121",
  "phoneNo": "+11234567890",
  "emailAddr": "user@example.com",
  "acctType": "\"personal\"",
  "ctryCd": "\"US\"",
  "personCreatedTs": "2020-10-28 13:00:24",
  "idDocNo": "123456789",
  "idDocType": "\"ssn\"",
  "currCd": "USD",
  "acctSubtype": "\"checking\"",
  "partnerId": "\"9999\"",
  "progId": "\"9999\"",
  "prodId": "\"9999\"",
  "balanceAsOfTs": "\"2020-10-28 13:00:24\"",
  "balanceReasonCd": "\"success\""
}

Response

status_codeinteger required

The response status code. May return a string for some statuses.

statusstring required

The condition of a process or response

errorsstring[]

A list of errors generated while the request was processed

rtokenstring nullable

A system-generated ID used for tracking

processing_timenumber nullable

The time elapsed in processing the request

system_timestampstring date-time nullable

A system generated timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.