Documentation

Fiat

fiat

Methods

Configure App For Fiat Onramping And Offramping -> { success }
post/v1/apps/{app_id}/fiat

Updates the app configuration for the specified onramp provider. This is used to set up the app for fiat onramping and offramping.

Get A KYC Link For A User -> { id, created_at, customer_id, 8 more... }
post/v1/users/{user_id}/fiat/kyc_link

Returns a KYC link for a user

Get A List Of Fiat Transactions And Their Statuses -> { transactions }
post/v1/users/{user_id}/fiat/status

Returns a list of fiat transactions and their statuses

Fiat

Accounts

fiat.accounts

Methods

Create A Fiat Account -> { id, account_type, currency, 2 more... }
post/v1/users/{user_id}/fiat/accounts

Sets up external bank account object for the user through the configured default provider. Requires the user to already be KYC'ed.

Get User S Fiat Accounts -> { accounts }
get/v1/users/{user_id}/fiat/accounts

Returns the IDs of all external fiat accounts (used for offramping) for the user

Fiat

KYC

fiat.kyc

Methods

Initiate KYC Verification For A User -> { status, user_id, provider_user_id }
post/v1/users/{user_id}/fiat/kyc

Initiates KYC verification process for a user with the configured provider

Get KYC Status For A User -> { status, user_id, provider_user_id }
get/v1/users/{user_id}/fiat/kyc

Get the current KYC verification status for a user from the configured provider

path Parameters
user_id: string

The ID of the user to get KYC status for

query Parameters
provider:
"bridge"
"bridge-sandbox"
Response fields
status: "not_found" | "active" | "awaiting_questionnaire" | 7 more...
user_id: string
provider_user_id: string
Optional
Request example
200Example
Update KYC Status For A User -> { status, user_id, provider_user_id }
patch/v1/users/{user_id}/fiat/kyc

Update the KYC verification status for a user from the configured provider

Fiat

Offramp

fiat.offramp

Methods

Initiate An Offramp Transaction -> { id, deposit_instructions, status }
post/v1/users/{user_id}/fiat/offramp

Triggers the offramp flow and gets the on-chain address to send funds to

Fiat

Onramp

fiat.onramp

Methods

Initiate An Onramp Transaction -> { id, deposit_instructions, status }
post/v1/users/{user_id}/fiat/onramp

Triggers an onramp to the specified recipient blockchain address, returns the bank deposit instructions