Skip to main content

private/fiat/fiat-get-plaid-token

POST 
/private/fiat/fiat-get-plaid-token
Get a Plaid link token for the user. Must call this before initiating the Plaid Link flow on the frontend. The token is single-use and expires — a new token is generated each time.

Request​

Body

required
    id int64required

    Request id (echoed in response)

    method stringrequired

    Must be "private/fiat/fiat-get-plaid-token"

    api_key stringrequired

    Your API key (only required for private REST)

    sig stringrequired

    HMAC-SHA256 signature in hex (only required for private REST)

    nonce int64required

    Current timestamp in milliseconds, e.g. "1773372503821".

    on_behalf_of_account_uuid stringrequired

    The account UUID of the user on whose behalf the broker is making the request

    params objectrequired
    redirect_uri uri

    Plaid Link redirect URI. Required for iOS. Must match a URI pre-registered with CDC during broker onboarding.

    android_package_name string

    Android package name used by Plaid Link for deep-link return. Required for Android.

    bank_account_id uuid

    Optional. When provided, puts Plaid Link into update (relink) mode for the specified bank account. Use when the account has status: expired. Omit for the initial linking flow.

Success.
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 = success; non-zero indicates error (reason code).

    result object
    Present when code === 0. Contains Plaid link token information.
    link_token stringrequired

    Plaid link token for initiating Plaid Link flow (single-use)

    expiration stringrequired

    Token expiration timestamp in ISO 8601 format

    request_id stringrequired

    Request identifier for tracking

    message string

    Present when code !== 0.

    original string

    Present when code !== 0.