AVavionte
Talent

Get Talent Accounts

Returns details about the specified talent account.

get/v1/applicant-account/{applicantId}

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/applicant-account/{applicantId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

applicantIdstring required

The identifier for the talent whose accounts are being retrieved.

Query parameters

includeArchivedboolean

An indication of whether archived accounts are included in the response. When true, both active and archived accounts are returned. When false (default), only active accounts are returned.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of bank accounts for the specified talent.

idinteger

The identifier for the bank account.

accountTypestring required

The account type.

routingNumberstring required

The routing number (9 digits).

accountNumberstring required

The account number.

institutionNumberstring required

The identifier for a financial institution, business, or company.

accountNamestring required

The name of the account.

accountCountrystring required

The country in which the bank operates. A 2-letter ISO 3166-1 alpha-2 code represents the country (e.g., "US", not "USA"). For details, see the <a href="https://developer.avionte.com/docs/general-guidelines#/data-formatting">General Guidelines</a>.

amountTypestring required

The amount type used to calculate the deposit. Options include Remaining Amount, Percent, and Fixed Amount. If Remaining Amount is selected, the amount must be set to 0, and only one of the talent's accounts can use this type.

amountnumber

The dollar amount or percentage that should be distributed to this account. The total percentage for all of the talent's accounts cannot exceed 100%.

accountOrderinteger

The order in which deposits are made to the talent’s accounts. Should be a unique integer within the list of a talent’s bank accounts.

isActivatedboolean

An indication of whether the Pay Card has been activated. If the account type is not Pay Card, this value is always false.

proxyNumberstring required

A short identifier that links a payment account to a unique reference, such as a phone number or email address, enabling transactions without exposing bank account details.

fundingTypestring required

The funding type (available for the rapid! PayCard account type).

Example response

[
  {
    "id": 278,
    "accountType": "Checking",
    "routingNumber": "291070001",
    "accountNumber": "234544111",
    "institutionNumber": "2847",
    "accountName": "Checking Account",
    "accountCountry": "US",
    "amountType": "Percent",
    "amount": 75,
    "accountOrder": 1,
    "isActivated": true,
    "proxyNumber": "125362",
    "fundingType": "Instant Payment"
  }
]

Changes

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