List all transfers, optionally filtering and paging the results.

By default, transfers are returned in reverse chronological (descending) order by creation time.

The recommended polling workflow is to query the results in ascending order (by setting order_by to CREATED_AT), keeping track of the created_at timestamp of the most recent transfer in the paged results. Once transfers are discovered, the caller should store the returned ID and query GetTransfer to retrieve status updates.

Get a single transfer by ID.

In the polling workflow, this endpoint can be called to monitor transfer status changes.

List all Fiat Accounts, optionally filtering and paging the results. The response includes an abbreviated FiatAccount object:

• Beneficiary name and address details are excluded.
• Only the last four (4) digits of the account number are included.

Use Get Fiat Account to retrieve the complete FiatAccount object.

The paginated results default to the maximum limit of 1,000 Fiat Accounts, unless otherwise specified with the limit parameter. Every paginated response contains a next_page field until the last page is reached. Pass the next_page value into the page_cursor field of the next request to retrieve the next page of results.

Create an account to initiate a fiat withdrawal.

For U.S. wires, set fiat_network_instructions > wire > routing_details > routing_number_type to ABA. For international (SWIFT) wires, set fiat_network_instructions > wire > routing_details > routing_number_type to SWIFT.

For CBIT, set fiat_network_instructions > cbit > wallet_address, and do not specify routing_number_type. For CBIT, the wallet_address on fiat_network_instructions is not a crypto wallet, it is a Customers Bank account wallet address.

Get a single Fiat Account by ID.

In the polling workflow, this endpoint can be called to monitor a FiatAccount's status. The Fiat Account response includes the full account number, beneficiary name and address details.

Delete a Fiat Account. Once a Fiat Account is deleted, transfers cannot be initiated to it.

Change an existing value or add a new value on one or more fields for the given Fiat Account and return the modified Fiat Account in PENDING status. Update fields in either fiat_account_owner.person_details or fiat_account_owner.institution_details. Attempts to convert the fiat_account_owner type results in an error. Empty strings or null values are ignored.

Upon successful response, Paxos initiates an automated review of the requested changes and then either sets the status to APPROVED or REJECTED. Occasionally, a manual review may be required. Use Get Fiat Account to check for status changes.

Return the associated Fiat Deposit Instructions matching the search criteria for the current Account. The paginated results default to the maximum limit of 1,000 Fiat Deposit instructions, unless otherwise specified with the limit parameter. Every paginated response contains a next_page field until the last page is reached. Pass the next_page value into the page_cursor field of the next request to retrieve the next page of results.

Create instructions for depositing fiat.

Get instructions for depositing fiat using a Paxos Fiat Deposit Instructions ID. The Fiat Deposit Instructions ID (id) is provided in the response of the Create Fiat Deposit Instructions.

Withdraw fiat to the given destination.

List all deposit addresses, optionally filtering and paging the results.

Create a deposit address on a blockchain network for depositing to a profile.

Reject a crypto deposit which is waiting for required travel rule information about the originator address. If the rejected deposit has any status other than NEEDS_INFO, the request will return an error. Only the creator of the crypto deposit can reject it.

Crypto deposits that do not meet the minimum travel rule requirements are blocked. To update a crypto deposit, provide the required travel rule information about the originator address.

Withdraw a cryptocurrency asset to a specified destination address.

Get a guaranteed fee for the given currency, valid for a period of time. Specify exactly one of amount or total, otherwise an error is returned.

The Create Crypto Withdrawal request that uses the guaranteed fee endpoint must specify an amount less than or equal to the guaranteed fee amount, otherwise the withdrawal is rejected.

Transfer assets between two profiles belonging to the same customer.

List all limits that apply to the given transaction type.

This endpoint enables you to fetch a list of identities that you have created within the Paxos platform. You can use query parameters to filter the results returned by:

• Summary Status of the Identity
• Date created
• Date updated

Note that this endpoint supports pagination and returns a cursor token for fetching next pages.

This enables you to create a new identity within the Paxos platform. Depending upon the fields provided, the identity will either be person or an institution.

• create person identity
• create institution identity

A successful response indicates that the identity has been created. This does not mean that it has already been processed. You can use the unique ID returned within the response to check the approval status of the identity.

Create Person Identity

The Person identity type is used to represent individuals on the platform. Attributes of the Person identity type are recorded in the person_details field.

Note that fields not listed below are forbidden in this request.

Field	Notes
person_details	Required
metadata	Optional
tax_details	Optional
ref_id	Optional

For US based identities, if the tax_details attribute is empty, it will be backfilled with the cip_id and cip_id_country fields from the person_details attribute. For international identities, the tax_details attribute must be present.

Currently both JUMIO or PASSTHROUGH are supported for verification, but only JUMIO is enabled by default.

• create person identity with jumio verification
• create person identity with passthrough verification

Automatic ID Verification with Jumio

To use Jumio, you must submit the fields listed below as part of the person_details attribute in your request.

Field	Notes
person_details.verifier_type	Required. Must be JUMIO
person_details.verifier_id	Required
person_details.address	Required

Please note that when using this method:

• You must ensure that the identity has already been validated by Jumio before submitting the identity to Paxos.
• You must have previously set the API credentials for Jumio access.

Paxos will compare the provided information with the information returned from the Jumio API.

In the event that there is a conflict between the submitted data and the data returned from the identity provider, the information from the identity provider will be preferred.

Example Request

{
  "person_details": {
    "verifier_id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
    "verifier_type": "JUMIO",
    "first_name": "John",
    "last_name": "Doe",
    "date_of_birth": "1980-01-01",
    "cip_id": "111-11-1111",
    "cip_id_type": "SSN",
    "cip_id_country": "USA",
    "nationality": "USA",
    "profession": "Engineer",
    "country_of_birth": "USA",
    "address": {
      "country": "USA",
      "address1": "1 Example St",
      "city": "New York",
      "province": "NY",
      "zip_code": "10001"
    },
    "ref_id": "33ece656-eef1-43b5-a851-b6b9099089a5"
  }
}

Automatic ID Verification with Passthrough

To use Passthrough, Paxos Compliance must first confirm your eligibility.

Once confirmed, you can submit the fields listed below as part of the the person_details attribute in your request.

Field	Notes
person_details.verifier_type	Required. Must be PASSTHROUGH
person_details.passthrough_verifier_type	Required. Specifies the ID Verification provider you originally used
person_details.passthrough_verified_at	Required
person_details.passthrough_verification_id	Unique identifier for the underlying individual's ID verification record.
person_details.passthrough_verification_status	Status of the ID verification indicating whether the identity was approved or denied.
person_details.passthrough_verification_fields	List of verification fields used by the external verifier to validate the individual's identity.
person_details.address	Required

Note that the following field is forbidden in the request: person_details.verifier_id

Example Request

{
  "person_details": {
    "verifier_type": "PASSTHROUGH",
    "passthrough_verifier_type": "JUMIO",
    "passthrough_verified_at": "2021-06-16T09:28:14Z",
    "passthrough_verification_id": "775300ef-4edb-47b9-8ec4-f45fe3cbf41f",
    "passthrough_verification_status": "APPROVED",
    "passthrough_verification_fields": ["FULL_LEGAL_NAME", "DATE_OF_BIRTH"]
    "first_name": "John",
    "last_name": "Doe",
    "date_of_birth": "1980-01-01",
    "cip_id_type": "SSN",
    "cip_id": "111-11-1111",
    "cip_id_country": "USA",
    "nationality": "USA",
    "profession": "Engineer",
    "country_of_birth": "USA",
    "address": {
      "country": "USA",
      "address1": "1 Example St",
      "city": "New York",
      "province": "NY",
      "zip_code": "10001"
    },
    "ref_id": "33ece656-eef1-43b5-a851-b6b9099089a5"
  }
}

Create Institution Identity

Institution identities are used to represent all non-person entities. Details for institution identity type are recorded in institution_details. An institution identity also has institution_members associated with it. This defines persons or other entities that have some relationship to the institution.

We support the following types and sub-types of institutions. Note that all institution types listed do share some common validations that can also be found below.

Supported Institution Types

institution_type	Supported institution_member roles	Notes
TRUST	BENEFICIAL_OWNER BENEFICIARY GRANTOR TRUSTEE	See Trusts
CORPORATION LLC PARTNERSHIP	ACCOUNT_OPENER AUTHORIZED_USER BENEFICIAL_OWNER MANAGEMENT_CONTROL_PERSON	See other Institutions

Industry Type to Institution Subtypes Mapping

institution_sub_type	industry
ACCOMMODATION_FOOD_SERVICES	Food or Beverage Services
ADMINISTRATIVE_SUPPORT_WASTE_MANAGEMENT_REMEDIATION_SERVICES	Administrative and Support Services
ADULT_ENTERTAINMENT	Adult Entertainment / Pornography
AGRICULTURE_FORESTRY_FISHING_HUNTING	Agriculture
ARTS_ENTERTAINMENT_RECREATION	Arts, Entertainment, and Recreation
AUCTIONS	Auction Houses / Art Galleries
AUTOMOBILES	Automobiles / Automotives
BLOCKCHAIN	Blockchain Technology
CONSTRUCTION	Construction
CRYPTO	Crypto Services and Products (Mining, Exchange, Broker)
DRUGS	Illicit Drugs / Drug Paraphernalia
E_COMMERCE	E-Commerce
EDUCATIONAL_SERVICES	Educational Services
EXPORT_IMPORT	Export / Import Companies
FINANCE_INSURANCE	Other Financial & Insurance Services (Not Referenced Elsewhere)
FINANCIAL_INSTITUTION	Financial Institution
GAMBLING	Gaming, Gambling, Casinos, or Sports Betting
HEALTH_CARE_SOCIAL_ASSISTANCE	Health Care and Social Assistance
HEDGE_FUND	Pooled Investment Vehicle / Investment Fund / Hedge Fund
INFORMATION	Information, Communications, and Media
INSURANCE	Insurance
INVESTMENT	Investment
MANAGEMENT_OF_COMPANIES_ENTERPRISES	Management of Companies & Enterprises (Holding Companies)
MANUFACTURING	Manufacturing
MARKET_MAKER	Market Maker / Proprietary Trading
MINING	Oil & Gas
MONEY_SERVICE_BUSINESS	Money Services Business / Money Transmitters (including ATMs)
NON_PROFIT	Non-Profit, Charity or Political Organizations
OTHER_SERVICES	Other
PRECIOUS_METALS	Jewelry or Precious Metals (Mining, Transportation, Dealing or Retail)
PROFESSIONAL_SCIENTIFIC_TECHNICAL_SERVICES	Professional Services (Consulting, Legal, Accounting, etc.)
PUBLIC_ADMINISTRATION	Public or Government Services
RANSOMWARE	Ransomware / Facilitators of Ransomware Transactions
REAL_ESTATE_RENTAL_LEASING	Real Estate and Rental and Leasing
REGISTERED_INVESTMENT_ADVISOR	Registered Investment Advisor
RETAIL_TRADE	Retail Trade
SHELL_BANK	Shell Banks or Shell Companies
STO_ISSUER	Security Token Offering (STO) Issuer
TRANSPORTATION_WAREHOUSING	Transportation and Services
TRAVEL_TRANSPORT	Travel, Accomodation or Transport
UTILITIES	Utilities
WEAPONS	Weapons or Arms (Manufacturing, Sales or Transportation)
WHOLESALE_TRADE	Wholesale Trade

Notes:

• INVESTMENT is only supported by the institution type TRUST.
• All other subtypes are only supported by types CORPORATION, LLC and PARTNERSHIP.

Prohibited Institution Subtypes

Paxos prohibits certain types of business activity (“Prohibited Businesses”) in accordance with its Compliance policies. The following non-exhaustive list is representative of the type of activity that Paxos prohibits on its platform. By creating a Paxos Identity, Paxos customers agree not to use Paxos services in connection with any of the following Prohibited Businesses.

• ADULT_ENTERTAINMENT
• DRUGS
• RANSOMWARE
• SHELL_BANK
• WEAPONS

Shared Validations Across All Institution Types

Field	Notes
cip_id	One of EIN, REGISTRATION_NUMBER, SSN, ITIN. SSN and ITIN are only supported for passthrough/revocable entities.
tax_details	Automatically populated if the cip_id_type is SSN, ITIN or EIN.
tax_details_not_required	Can be set for non-US institutions where tax details are not required.
metadata	Optional
ref_id	Optional

Specifying Institution Members and Their Roles

Field	Notes
identity_id	Required
roles	Required.
ownership	Optional. Must be between 0 and 100
position	Optional

Note See supported institution types for details on which roles are supported by which institution type.

Fields Required for Trusts

Type	Fields
Required	name, cip_id, cip_id_type, cip_id_country, institution_type, institution_sub_type, business_address, govt_registration_date
Optional	phone_number, email, incorporation_address, regulation_status, trading_type, listed_exchange, ticker_symbol, parent_institution_name, regulator_jurisdiction, regulator_name, regulator_register_number

Notes Fields not listed are forbidden in the request. institution_type must be set to TRUST. institution_sub_type must be set to Investment. incorporation_address is required for Trusts where their cip_id_type is not SSN or ITIN.

Example Request for a Trust

{
  "institution_members": [{
     "identity_id": "33ece656-eef1-43b5-a851-b6b9099089a5",
     "roles": ["GRANTOR"]
    },
    {
     "identity_id": "44ece656-eef1-43b5-a851-b6b9099089a6",
     "roles": ["TRUSTEE"]
    }],
  "institution_details": {
    "name": "Trust A",
    "business_address": {
      "country": "United States",
      "address1": "1 Example St",
      "city": "New York",
      "province": "NY",
      "zip_code": "10001"
    },
    "email": "institution_a@acorp.com",
    "institution_type": "CORPORATION",
    "institution_sub_type": "HEDGE_FUND",
    "cip_id": "11-1111111",
    "cip_id_type": "EIN",
    "cip_id_country": "USA",
    "govt_registration_date": "2021-04-14T00:00:00Z",
    "incorporation_address": {
      "country": "United States",
      "address1": "1 Example St",
      "city": "New York",
      "province": "NY",
      "zip_code": "10001"
    },
    "regulation_status": "US_REGULATED",
    "trading_type": "PUBLIC",
    "listed_exchange": "NASDAQ",
    "ticker_symbol": "ABC",
    "regulator_name": "SEC",
    "regulator_jurisdiction": "USA",
    "regulator_register_number": "111-111111"
  }
}

Fields Required for Institutions (excluding Trusts and Registered Investment Advisors)

Type	Fields
Required	name, cip_id, cip_id_type, cip_id_country, institution_type, institution_sub_type, business_address, incorporation_address, govt_registration_date, regulation_status, trading_type
Optional	phone_number, email, listed_exchange, ticker_symbol, parent_institution_name, regulator_jurisdiction, regulator_name, regulator_register_number

Creating Financially Regulated Institutions

Please refer to the following table for creating institutions which are financially regulated.

regulation_status	Notes
US_REGULATED	Institution financially regulated in the US
INTL_REGULATED	Institution financially regulated by an international entity
NON_REGULATED	Non-financially regulated institution

Note that each category of regulation_status then has additional validations tied to trading type and other required fields.

regulation_status	trading_type	fields required	Notes
US_REGULATED	PRIVATE	regulator_name, regulator_jurisdiction, regulator_register_number	Not publicly traded
US_REGULATED	PUBLIC	listed_ exchange, ticker_symbol, regulator_name, regulator_jurisdiction, regulator_register_number	Publicly traded
US_REGULATED	PUBLICLY_TRADED_SUBSIDIARY	listed_exchange, ticker_symbol, regulator_name, regulator_jurisdiction, regulator_register_number, parent_institution_name	Subsidiary of a publicly traded company
INTL_REGULATED	PRIVATE	regulator_name, regulator_jurisdiction, regulator_register_number	Not publicly traded
INTL_REGULATED	PUBLIC	listed_ exchange, ticker_symbol, regulator_name, regulator_jurisdiction, regulator_register_number	Publicly traded
INTL_REGULATED	PUBLICLY_TRADED_SUBSIDIARY	listed_exchange, ticker_symbol, regulator_name, regulator_jurisdiction, regulator_register_number, parent_institution_name	Subsidiary of a publicly traded company
NON_REGULATED	PRIVATE	PRIVATE	Not publicly traded
NON_REGULATED	PUBLIC	listed_exchange, ticker_symbol	Publicly traded

Fields required for Registered Investment Advisors (RIA)

RIAs are a special sub-type of Institution. Usage of this sub-type requires prior authorization and approval from Paxos.

Notes institution_sub_type must be set to REGISTERED_INVESTMENT_ADVISOR. The list of required and optional fields below varies slightly from other supported institutions while certain fields are optional (e.g. trading_type), if they are specified in the request, their input will been validated

Type	Fields
Required	name, cip_id, cip_id_type, cip_id_country, institution_type, institution_sub_type, business_address, regulation_status, regulator_jurisdiction, regulator_name, regulator_register_number
Optional	phone_number, email, listed_exchange, ticker_symbol, parent_institution_name, incorporation_address, govt_registration_date, trading_type