Identity Document sharing

Ramps
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Enable Get and Post on ramp and off ramp

OperationsWebhooks

Identities
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Enable Sharing and reliance of identity through token(sumsub), reliance or by sending us documents.

OperationsWebhooks

Identity token sharing (sumsub)

Request

Share customer identity

Security

HMACAuth

Bodyapplication/jsonrequired

identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

emailstring(email)<= 200 charactersrequired

The customer email

Example: "user@banxa.com"

mobileNumberstringrequired

Example: 61410001000

providerobjectrequired

provider.vendorstringrequired

The KYC provider e.g. sumsub

Value"sumsub"

Example: "sumsub"

provider.tokenstring>= 6required

Arbitrary string

Example: "eyJhbGciOiJub25lIn0.eyJqdGkiOiJfYWN0LTZmODI2ZTU0LTE2MzctNDViMS05NzMyLWY1MjZiN2YxNWE3YyIsInVybCI6Imh0dHBzOi8vYXBpLnN1bXN1Yi5jb20ifQ."

curl -i -X POST \
  https://banxa-enterprise.redocly.app/_mock/enterprise-api/v0-beta/openapi/eapi/v0/identities/token/share \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityReference": "c-13344",
    "email": "user@banxa.com",
    "mobileNumber": 61410001000,
    "provider": {
      "vendor": "sumsub",
      "token": "eyJhbGciOiJub25lIn0.eyJqdGkiOiJfYWN0LTZmODI2ZTU0LTE2MzctNDViMS05NzMyLWY1MjZiN2YxNWE3YyIsInVybCI6Imh0dHBzOi8vYXBpLnN1bXN1Yi5jb20ifQ."
    }
  }'

Responses

The identity sharing request has been accepted for processing, but the processing has not been finished yet.

Bodyapplication/json

identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

Response

application/json

{
  "identityReference": "c-13344"
}

Identity Reliance

Request

Share customer identity

Security

HMACAuth

Bodyapplication/jsonrequired

identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

mobileNumberstringrequired

Mobile number of the customer.

Example: "61431000001"

emailstring(email)required

Email address of the customer.

Example: "test@bitcoin.com.au"

screeningDatestring(date)required

The UTC screening date of the applicant.

Example: "2023-06-05"

screeningSanctionsResultbooleanrequired

The result of the sanction screening.

Example: true

screeningPepResultbooleanrequired

The result of the PEP sanction screening.

Example: true

customerIdentityobject(CustomerIdentity)required

customerIdentity.givenNamestringrequired

Customer's given / first name.

Example: "Joe"

customerIdentity.surnamestringrequired

Customer's surname / last name.

Example: "Bloggs"

customerIdentity.dobstring(date)required

Customer's date of birth (e.g. "1985-01-31"). Required to format as ISO 8601 Date format : YYYY-MM-DD.

Example: "1990-01-31"

customerIdentity.taxIdTypestring

Tax identification number (e.g. SSN). Optional unless required (e.g. for US). This is the national identifier for the customer, for example, the customer's Social Security number (SSN) in the US. Must be a nine-digit number in the format "AAA-GG-SSSS".

Example: "ssn"

customerIdentity.taxIdstring

Tax identification number (e.g. SSN). Optional unless required (e.g. for US). This is the national identifier for the customer, for example, the customer's Social Security number (SSN) in the US. Must be a nine-digit number in the format "AAA-GG-SSSS".

Example: "123-11-123"

customerIdentity.taxStatestring

Tax state or region if applicable.(associated with the taxId) Required format as two characters. Note; We do not accept any states where Banxa is not licensed.

Example: "IL"

customerIdentity.residentialAddressobject(ResidentialAddress)required

customerIdentity.residentialAddress.addressLinestringrequired

Street address.

Example: "44 Gwynne Street"

customerIdentity.residentialAddress.suburbstringrequired

Suburb of the address.

Example: "Cremorne"

customerIdentity.residentialAddress.statestringrequired

State or region, required when country is US.

Example: "VIC"

customerIdentity.residentialAddress.postCodestringrequired

Postal code.

Example: "3121"

customerIdentity.residentialAddress.countrystringrequired

Country code.

Example: "AU"

identityDocumentsArray of objects(IdentityRelianceDocument)required

Collection of identity documents colected frofmo the customer. (array of objects)

identityDocuments[].typestring

The type of document collected from the applicant.

Enum"DRIVING_LICENSE""PASSPORT""IDENTIFICATION"

Example: "DRIVING_LICENSE"

identityDocuments[].dataobject

The document data collected from the customer.

curl -i -X POST \
  https://banxa-enterprise.redocly.app/_mock/enterprise-api/v0-beta/openapi/eapi/v0/identities/reliance \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityReference": "c-13344",
    "mobileNumber": "61431000001",
    "email": "test@bitcoin.com.au",
    "screeningDate": "2023-06-05",
    "screeningSanctionsResult": true,
    "screeningPepResult": true,
    "customerIdentity": {
      "givenName": "Joe",
      "surname": "Bloggs",
      "dob": "1990-01-31",
      "taxIdType": "ssn",
      "taxId": "123-11-123",
      "taxState": "IL",
      "residentialAddress": {
        "addressLine": "44 Gwynne Street",
        "suburb": "Cremorne",
        "state": "VIC",
        "postCode": "3121",
        "country": "AU"
      }
    },
    "identityDocuments": [
      {
        "type": "DRIVING_LICENSE",
        "data": {
          "number": "123456789"
        }
      }
    ]
  }'

Responses

The identity sharing request has been accepted for processing

Bodyapplication/json

identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

Response

application/json

{
  "identityReference": "c-13344"
}

Identity Document sharing

Request

Share identity documents

Security

HMACAuth

Bodyapplication/jsonrequired

identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

mobileNumberstringrequired

Mobile (msisdn) number of the customer.

Example: "+61431000001"

emailstring(email)required

Email address of the customer.

Example: "test@bitcoin.com.au"

customerIdentityobject(CustomerIdentity)required

customerIdentity.givenNamestringrequired

Customer's given / first name.

Example: "Joe"

customerIdentity.surnamestringrequired

Customer's surname / last name.

Example: "Bloggs"

customerIdentity.dobstring(date)required

Customer's date of birth (e.g. "1985-01-31"). Required to format as ISO 8601 Date format : YYYY-MM-DD.

Example: "1990-01-31"

customerIdentity.taxIdTypestring

Tax identification number (e.g. SSN). Optional unless required (e.g. for US). This is the national identifier for the customer, for example, the customer's Social Security number (SSN) in the US. Must be a nine-digit number in the format "AAA-GG-SSSS".

Example: "ssn"

customerIdentity.taxIdstring

Tax identification number (e.g. SSN). Optional unless required (e.g. for US). This is the national identifier for the customer, for example, the customer's Social Security number (SSN) in the US. Must be a nine-digit number in the format "AAA-GG-SSSS".

Example: "123-11-123"

customerIdentity.taxStatestring

Tax state or region if applicable.(associated with the taxId) Required format as two characters. Note; We do not accept any states where Banxa is not licensed.

Example: "IL"

customerIdentity.residentialAddressobject(ResidentialAddress)required

customerIdentity.residentialAddress.addressLinestringrequired

Street address.

Example: "44 Gwynne Street"

customerIdentity.residentialAddress.suburbstringrequired

Suburb of the address.

Example: "Cremorne"

customerIdentity.residentialAddress.statestringrequired

State or region, required when country is US.

Example: "VIC"

customerIdentity.residentialAddress.postCodestringrequired

Postal code.

Example: "3121"

customerIdentity.residentialAddress.countrystringrequired

Country code.

Example: "AU"

occupationIndustrystringrequired

Industry related to the customer's occupation. The valid values for 'occupation' depend on the selected 'occupationIndustry'. For example, if 'occupationIndustry' is 'Consulting, IT, or business services', only certain occupations are valid. Refer to the Occupation-Industry mapping table in the API documentation for allowed combinations. This relationship is strictly enforced by server-side validation.

Enum"Consulting, IT, or business services""Design, marketing or communication""Travel, accommodation, or transport""Entertainment, arts or photography""Health, sports or personal care""Food, beverages, or tobacco""Retail, eCommerce, wholesale or manufacturing""Dealers & Resellers""Financial services, products, or holding companies""Real estate or construction"

Example: "Consulting, IT, or business services"

occupationstringrequired

Customer's occupation.
Must be a valid occupation for the selected 'occupationIndustry'.
When the selected combination is invalid a validation error will be thrown.
Refer to the Occupation-Industry mapping table:

occupationIndustry	occupation
Consulting, IT, or business services	Architect
Consulting, IT, or business services	IT developer
Consulting, IT, or business services	IT hosting services
Consulting, IT, or business services	IT consulting/services - other
Consulting, IT, or business services	Scientific or technical consulting
Consulting, IT, or business services	Management consulting and coaching
Consulting, IT, or business services	Employment placement and recruitment services
Consulting, IT, or business services	Cleaning, repair and maintenance services
Consulting, IT, or business services	Financial (inc. tax, accounting, audit)
Consulting, IT, or business services	Lawyer / Legal services
Consulting, IT, or business services	Translation or language services
Consulting, IT, or business services	Company establishment/formation services
Consulting, IT, or business services	Freelance platform
Consulting, IT, or business services	Other consulting
Design, marketing or communication	Advertising and marketing
Design, marketing or communication	Designer
Design, marketing or communication	Interior design
Design, marketing or communication	Audio and video
Design, marketing or communication	Photography
Design, marketing or communication	Print and online media
Design, marketing or communication	Translation or language services
Design, marketing or communication	Telecommunications services
Travel, accommodation, or transport	Travel agent
Travel, accommodation, or transport	Tour operator
Travel, accommodation, or transport	Accommodation or hotelier
Travel, accommodation, or transport	Other travel or tour activities
Travel, accommodation, or transport	Passenger transport or rentals
Travel, accommodation, or transport	Freight transport
Travel, accommodation, or transport	Rideshare and transport share services
Travel, accommodation, or transport	Transport - other
Entertainment, arts or photography	Audio and video engineer
Entertainment, arts or photography	Events and entertainment organiser
Entertainment, arts or photography	Photographer
Entertainment, arts or photography	Books, magazines, blogs, news
Entertainment, arts or photography	Video gaming
Entertainment, arts or photography	Performing arts
Entertainment, arts or photography	Gambling, betting, and lotteries
Entertainment, arts or photography	Telecommunications services
Entertainment, arts or photography	Adult Entertainment
Health, sports or personal care	Beautician
Health, sports or personal care	Vitamins and dietary supplements
Health, sports or personal care	Fitness or sports services
Health, sports or personal care	Medical or veterinary services
Health, sports or personal care	Dental services
Health, sports or personal care	Medical equipment
Health, sports or personal care	Elderly or other care home
Health, sports or personal care	Nursing or other care services
Health, sports or personal care	Pharmaceuticals
Health, sports or personal care	Pharmacy
Food, beverages, or tobacco	Food manufacturing and retail
Food, beverages, or tobacco	Restaurants and catering
Food, beverages, or tobacco	Vitamins and dietary supplements
Food, beverages, or tobacco	Alcohol
Food, beverages, or tobacco	Soft drinks
Food, beverages, or tobacco	Tobacco
Retail, eCommerce, wholesale or manufacturing	Clothing and accessories
Retail, eCommerce, wholesale or manufacturing	Beauty products and services
Retail, eCommerce, wholesale or manufacturing	Home and garden
Retail, eCommerce, wholesale or manufacturing	Toys, games and musical instruments
Retail, eCommerce, wholesale or manufacturing	Electronics and electrical products
Retail, eCommerce, wholesale or manufacturing	Sports equipment (excl. weapons)
Retail, eCommerce, wholesale or manufacturing	Manufacturing
Retail, eCommerce, wholesale or manufacturing	Farming, seeds, plants
Retail, eCommerce, wholesale or manufacturing	Pets or pet supplies
Dealers & Resellers	Vehicle sales
Dealers & Resellers	Vehicle accessories, spare parts, manufacturing
Dealers & Resellers	Machinery and equipment
Dealers & Resellers	Firearms, weapons, and military goods/services
Dealers & Resellers	Arts - fine art sales, auctions or procurement
Dealers & Resellers	Arts - other arts and crafts products or services
Dealers & Resellers	Jewellery - fine jewellery, watches
Dealers & Resellers	Jewellery - fashion jewellery
Dealers & Resellers	Precious stones, diamonds, or metals
Dealers & Resellers	Chemicals
Dealers & Resellers	Legal highs and related accessories
Dealers & Resellers	Selling products on behalf of others (incl. auction, online marketplace)
Dealers & Resellers	Other retail or wholesale (not listed above)
Financial services, products, or holding companies	Financial Adviser (inc. tax, accounting, audit)
Financial services, products, or holding companies	Investment Manager
Financial services, products, or holding companies	Money service business operator
Financial services, products, or holding companies	Professional Trader
Financial services, products, or holding companies	Insurance Manager
Financial services, products, or holding companies	Crowdfunding and peer lending
Financial services, products, or holding companies	Other financial services
Real estate or construction	Real estate sale, purchase, and management
Real estate or construction	Construction
Real estate or construction	Real estate development
Education or learning	Online learning
Education or learning	Teaching and tutoring
Education or learning	Schools and universities
Charity or not-for-profit	Any charity related activity
Public or government services	Government Official
Public or government services	Politician
Public or government services	Other, not listed above
Utility services	Utility services and providers
Utility services	Cleaning, repair and maintenance services
Utility services	Telecommunications services
Utility services	Other, not listed above
Unemployed/Retired	Unemployed/Retired
In between jobs/looking for work	In between jobs/looking for work
Fulltime student	Fulltime student

Enum"Architect""IT developer""IT hosting services""IT consulting/services - other""Scientific or technical consulting""Management consulting and coaching""Employment placement and recruitment services""Cleaning, repair and maintenance services""Financial (inc. tax, accounting, audit)""Lawyer / Legal services"

Example: "IT developer"

sourceOfFundsstringrequired

Source from which funds are obtained.

Enum"Personal Savings""Salary""Business Income/Profits""Pension""Government Benefits""Income from Cryptocurrency Trading""Income from Investments (e.g. shares, bonds, investment funds)""Income from sale of real estate or other property""Income from renting/leasing""Private loan from family members/ friends/others"

Example: "Salary"

purposeOfTransactionstringrequired

Purpose for the transaction.

Value"investment"

Example: "investment"

identityDocumentsArray of Passport / Driving License / ID (object) or Proof of Address / Selfie (object)(IdentityDocument)required

Collection of identity documents provided by the customer. (array of objects)

One of:

identityDocuments[].typestringrequired

The type of document provided.

Enum"DRIVING_LICENSE""PASSPORT""IDENTIFICATION""PROOF_OF_ADDRESS""SELFIE"

Example: "DRIVING_LICENSE"

identityDocuments[].dataobjectrequired

Required when the document "type" is "PASSPORT", "DRIVING_LICENSE", or "IDENTIFICATION".

identityDocuments[].data.numberstring

Identifier number from the document.

Example: "123456789"

identityDocuments[].imagesArray of Driving License / Identification (object) or Other (object)(Image)required

One or more images of the document.

One of:

The mimetype field is required and must be either image/jpeg or image/png. Note: JSON does not support line breaks in string values, so the Base64-encoded content must be provided as a single continuous line without any line breaks.

identityDocuments[].images[].typestring

Enum"DRIVING_LICENSE""IDENTIFICATION"

Example: "DRIVING_LICENSE"

identityDocuments[].images[].base64string(byte)/^[a-z0-9\/\r\n+]*={0,2}$/irequired

Base64-encoded file content. Maximum original file size before encoding is 10 MB.

Example: "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P49/8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="

identityDocuments[].images[].mimetypestringrequired

MIME type of the image, we support image/jpeg and image/png mimetypes

Example: "image/png"

identityDocuments[].images[].sidestringrequired

The side of the identity document

Enum"FRONT""BACK"

Example: "FRONT"

curl -i -X POST \
  https://banxa-enterprise.redocly.app/_mock/enterprise-api/v0-beta/openapi/eapi/v0/identities/share/documents \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityReference": "c-13344",
    "mobileNumber": "+61431000001",
    "email": "test@bitcoin.com.au",
    "customerIdentity": {
      "givenName": "Joe",
      "surname": "Bloggs",
      "dob": "1990-01-31",
      "taxIdType": "ssn",
      "taxId": "123-11-123",
      "taxState": "IL",
      "residentialAddress": {
        "addressLine": "44 Gwynne Street",
        "suburb": "Cremorne",
        "state": "VIC",
        "postCode": "3121",
        "country": "AU"
      }
    },
    "occupationIndustry": "Consulting, IT, or business services",
    "occupation": "IT developer",
    "sourceOfFunds": "Salary",
    "purposeOfTransaction": "investment",
    "identityDocuments": [
      {
        "type": "PASSPORT",
        "data": {
          "number": "123456789"
        },
        "images": [
          {
            "base64": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P49/8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
            "mimetype": "image/png",
            "side": "FRONT",
            "type": "DRIVING_LICENSE"
          }
        ]
      }
    ]
  }'

Responses

The identity document sharing request has been accepted for processing, but the processing of the sent documents has not been finished yet.

Bodyapplication/json

identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

statusstringrequired

Status of the onboarding request

Enum"PENDING""APPROVED""REJECTED"

Example: "PENDING"

rejectionReasonobject(RejectionReason)

customerIdentityobject(CustomerIdentity)

occupationIndustrystring

Industry related to the customer's occupation.

Example: "Consulting, IT, or business services"

occupationstring

Customer's occupation.

Example: "IT developer"

purposeOfTransactionstring

Purpose for the transaction.

Example: "investment"

createdAtstring(date-time)

The UTC date time of the identity.

Example: "2023-06-05T19:53:08.320Z"

Response

application/json

{
  "identityReference": "c-13344",
  "status": "PENDING",
  "rejectionReason": {
    "internalReason": "Image document blurry",
    "reason": "Image document blurry. Please re-submit."
  },
  "customerIdentity": {
    "givenName": "Joe",
    "surname": "Bloggs",
    "dob": "1990-01-31",
    "taxIdType": "ssn",
    "taxId": "123-11-123",
    "taxState": "IL",
    "residentialAddress": { … }
  },
  "occupationIndustry": "Consulting, IT, or business services",
  "occupation": "IT developer",
  "purposeOfTransaction": "investment",
  "createdAt": "2023-06-05T19:53:08.320Z"
}

Identity update

Request

Update identity

Security

HMACAuth

Bodyapplication/jsonrequired

identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

mobileNumberstring

Mobile (msisdn) number of the customer.

Example: "+61431000001"

emailstring(email)required

Email address of the customer.

Example: "test@bitcoin.com.au"

customerIdentityobject

occupationIndustrystring

Industry related to the customer's occupation. The valid values for 'occupation' depend on the selected 'occupationIndustry'. For example, if 'occupationIndustry' is 'Consulting, IT, or business services', only certain occupations are valid. Refer to the Occupation-Industry mapping table in the API documentation for allowed combinations. This relationship is strictly enforced by server-side validation.

Enum"Consulting, IT, or business services""Design, marketing or communication""Travel, accommodation, or transport""Entertainment, arts or photography""Health, sports or personal care""Food, beverages, or tobacco""Retail, eCommerce, wholesale or manufacturing""Dealers & Resellers""Financial services, products, or holding companies""Real estate or construction"

Example: "Consulting, IT, or business services"

occupationstring

Customer's occupation.
Must be a valid occupation for the selected 'occupationIndustry'.
When the selected combination is invalid a validation error will be thrown.
Refer to the Occupation-Industry mapping table:

occupationIndustry	occupation
Consulting, IT, or business services	Architect
Consulting, IT, or business services	IT developer
Consulting, IT, or business services	IT hosting services
Consulting, IT, or business services	IT consulting/services - other
Consulting, IT, or business services	Scientific or technical consulting
Consulting, IT, or business services	Management consulting and coaching
Consulting, IT, or business services	Employment placement and recruitment services
Consulting, IT, or business services	Cleaning, repair and maintenance services
Consulting, IT, or business services	Financial (inc. tax, accounting, audit)
Consulting, IT, or business services	Lawyer / Legal services
Consulting, IT, or business services	Translation or language services
Consulting, IT, or business services	Company establishment/formation services
Consulting, IT, or business services	Freelance platform
Consulting, IT, or business services	Other consulting
Design, marketing or communication	Advertising and marketing
Design, marketing or communication	Designer
Design, marketing or communication	Interior design
Design, marketing or communication	Audio and video
Design, marketing or communication	Photography
Design, marketing or communication	Print and online media
Design, marketing or communication	Translation or language services
Design, marketing or communication	Telecommunications services
Travel, accommodation, or transport	Travel agent
Travel, accommodation, or transport	Tour operator
Travel, accommodation, or transport	Accommodation or hotelier
Travel, accommodation, or transport	Other travel or tour activities
Travel, accommodation, or transport	Passenger transport or rentals
Travel, accommodation, or transport	Freight transport
Travel, accommodation, or transport	Rideshare and transport share services
Travel, accommodation, or transport	Transport - other
Entertainment, arts or photography	Audio and video engineer
Entertainment, arts or photography	Events and entertainment organiser
Entertainment, arts or photography	Photographer
Entertainment, arts or photography	Books, magazines, blogs, news
Entertainment, arts or photography	Video gaming
Entertainment, arts or photography	Performing arts
Entertainment, arts or photography	Gambling, betting, and lotteries
Entertainment, arts or photography	Telecommunications services
Entertainment, arts or photography	Adult Entertainment
Health, sports or personal care	Beautician
Health, sports or personal care	Vitamins and dietary supplements
Health, sports or personal care	Fitness or sports services
Health, sports or personal care	Medical or veterinary services
Health, sports or personal care	Dental services
Health, sports or personal care	Medical equipment
Health, sports or personal care	Elderly or other care home
Health, sports or personal care	Nursing or other care services
Health, sports or personal care	Pharmaceuticals
Health, sports or personal care	Pharmacy
Food, beverages, or tobacco	Food manufacturing and retail
Food, beverages, or tobacco	Restaurants and catering
Food, beverages, or tobacco	Vitamins and dietary supplements
Food, beverages, or tobacco	Alcohol
Food, beverages, or tobacco	Soft drinks
Food, beverages, or tobacco	Tobacco
Retail, eCommerce, wholesale or manufacturing	Clothing and accessories
Retail, eCommerce, wholesale or manufacturing	Beauty products and services
Retail, eCommerce, wholesale or manufacturing	Home and garden
Retail, eCommerce, wholesale or manufacturing	Toys, games and musical instruments
Retail, eCommerce, wholesale or manufacturing	Electronics and electrical products
Retail, eCommerce, wholesale or manufacturing	Sports equipment (excl. weapons)
Retail, eCommerce, wholesale or manufacturing	Manufacturing
Retail, eCommerce, wholesale or manufacturing	Farming, seeds, plants
Retail, eCommerce, wholesale or manufacturing	Pets or pet supplies
Dealers & Resellers	Vehicle sales
Dealers & Resellers	Vehicle accessories, spare parts, manufacturing
Dealers & Resellers	Machinery and equipment
Dealers & Resellers	Firearms, weapons, and military goods/services
Dealers & Resellers	Arts - fine art sales, auctions or procurement
Dealers & Resellers	Arts - other arts and crafts products or services
Dealers & Resellers	Jewellery - fine jewellery, watches
Dealers & Resellers	Jewellery - fashion jewellery
Dealers & Resellers	Precious stones, diamonds, or metals
Dealers & Resellers	Chemicals
Dealers & Resellers	Legal highs and related accessories
Dealers & Resellers	Selling products on behalf of others (incl. auction, online marketplace)
Dealers & Resellers	Other retail or wholesale (not listed above)
Financial services, products, or holding companies	Financial Adviser (inc. tax, accounting, audit)
Financial services, products, or holding companies	Investment Manager
Financial services, products, or holding companies	Money service business operator
Financial services, products, or holding companies	Professional Trader
Financial services, products, or holding companies	Insurance Manager
Financial services, products, or holding companies	Crowdfunding and peer lending
Financial services, products, or holding companies	Other financial services
Real estate or construction	Real estate sale, purchase, and management
Real estate or construction	Construction
Real estate or construction	Real estate development
Education or learning	Online learning
Education or learning	Teaching and tutoring
Education or learning	Schools and universities
Charity or not-for-profit	Any charity related activity
Public or government services	Government Official
Public or government services	Politician
Public or government services	Other, not listed above
Utility services	Utility services and providers
Utility services	Cleaning, repair and maintenance services
Utility services	Telecommunications services
Utility services	Other, not listed above
Unemployed/Retired	Unemployed/Retired
In between jobs/looking for work	In between jobs/looking for work
Fulltime student	Fulltime student

Enum"Architect""IT developer""IT hosting services""IT consulting/services - other""Scientific or technical consulting""Management consulting and coaching""Employment placement and recruitment services""Cleaning, repair and maintenance services""Financial (inc. tax, accounting, audit)""Lawyer / Legal services"

Example: "IT developer"

sourceOfFundsstring

Source from which funds are obtained.

Enum"Personal Savings""Salary""Business Income/Profits""Pension""Government Benefits""Income from Cryptocurrency Trading""Income from Investments (e.g. shares, bonds, investment funds)""Income from sale of real estate or other property""Income from renting/leasing""Private loan from family members/ friends/others"

Example: "Salary"

purposeOfTransactionstring

Purpose for the transaction.

Value"investment"

Example: "investment"

identityDocumentsArray of Passport / Driving License / ID (object) or Proof of Address / Selfie (object)(IdentityDocument)

Collection of identity documents provided by the customer. (array of objects)

curl -i -X PATCH \
  https://banxa-enterprise.redocly.app/_mock/enterprise-api/v0-beta/openapi/eapi/v0/identities \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityReference": "c-13344",
    "mobileNumber": "+61431000001",
    "email": "test@bitcoin.com.au",
    "customerIdentity": {
      "givenName": "Joe",
      "surname": "Bloggs",
      "dob": "1990-01-31",
      "taxIdType": "ssn",
      "taxId": "123-11-123",
      "taxState": "VIC",
      "residentialAddress": {
        "addressLine": "44 Gwynne Street",
        "suburb": "Cremorne",
        "state": "VIC",
        "postCode": "3121",
        "country": "AU"
      }
    },
    "occupationIndustry": "Consulting, IT, or business services",
    "occupation": "IT developer",
    "sourceOfFunds": "Salary",
    "purposeOfTransaction": "investment",
    "identityDocuments": [
      {
        "type": "PASSPORT",
        "data": {
          "number": "123456789"
        },
        "images": [
          {
            "base64": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P49/8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
            "mimetype": "image/png",
            "side": "FRONT",
            "type": "DRIVING_LICENSE"
          }
        ]
      }
    ]
  }'

Responses

No content, success

Response

No content

Identity Retrieval

Request

Enables retrieval of detailed information about a specific identity using the unique identityReference.

Security

HMACAuth

Path

identity_referencestring<= 100 charactersrequired

The identity reference to retrieve data for.

Example: /identities/c-13344

Query

emailstring(email)<= 254 characters

Optional email address to assist with identity matching.

Example: email=user@example.com

curl -i -X GET \
  'https://banxa-enterprise.redocly.app/_mock/enterprise-api/v0-beta/openapi/eapi/v0/identities//identities/c-13344?email=user%40example.com' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful identity response

Bodyapplication/json

identifyReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

accountobjectrequired

account.blockedbooleanrequired

The account status

Example: false

account.existsbooleanrequired

Indicated wether the account exists

Example: true

account.createdAtstring(date-time)required

The UTC date time of the identity.

Example: "2023-06-05T19:53:08.320Z"

Response

application/json

{
  "identifyReference": "c-13344",
  "account": {
    "blocked": false,
    "exists": true,
    "createdAt": "2023-06-05T19:53:08.320Z"
  }
}

Identity create

Request

Low level identity onboarding

Security

HMACAuth

Bodyapplication/jsonrequired

identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

givenNamestring

Company representative first name.

Example: "Joe"

surnamestring

Company representative last name.

Example: "Bloggs"

dateOfBirthstring(date)

Date of birth in YYYY-MM-DD format. Must be a past date.

Example: "1990-05-21"

emailstring(email)

Email address of the customer.

Example: "test@solana.com.au"

residentialAddressobject(ResidentialAddress)

curl -i -X POST \
  https://banxa-enterprise.redocly.app/_mock/enterprise-api/v0-beta/openapi/eapi/v0/identities/basic \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityReference": "c-13344",
    "givenName": "Joe",
    "surname": "Bloggs",
    "dateOfBirth": "1990-05-21",
    "email": "test@solana.com.au",
    "residentialAddress": {
      "addressLine": "44 Gwynne Street",
      "suburb": "Cremorne",
      "state": "VIC",
      "postCode": "3121",
      "country": "AU"
    }
  }'

Responses

The identity has been created

Bodyapplication/json

identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

createdAtstring(date-time)required

The UTC date time of the identity.

Example: "2023-06-05T19:53:08.320Z"

Response

application/json

{
  "identityReference": "c-13344",
  "createdAt": "2023-06-05T19:53:08.320Z"
}

Inbound message regarding customer Identity related messagesWebhook

Request

When a customer failed to create an order for a specific reason, the status update will be sent to the provided callback endpoint to your server.

Bodyapplication/jsonrequired

identity_referencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"

statusstringrequired

Status	Description
CUSTOMER_BLACKLISTED	Customer has been blacklisted.

Value"CUSTOMER_BLACKLISTED"

Example: "CUSTOMER_BLACKLISTED"

status_datestring(datetime)required

The date of the status update

Example: "2023-06-05 19:53:08"

internal_reasonstringrequired

The internal body for this inbound message containing the reason of the message, this is for internal use.

Example: "Customer has been blacklisted"

external_reasonstringrequired

The external reason to provide to your customer via your designated messaging channel.

Example: "You order could not be processed"

application/json

{
  "identity_reference": "c-13344",
  "status": "CUSTOMER_BLACKLISTED",
  "status_date": "2023-06-05 19:53:08",
  "internal_reason": "Customer has been blacklisted",
  "external_reason": "You order could not be processed"
}

Responses

Your server returns this code if it accepts the callback. On a failed response we will retry sending the webook.

Price
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request a price prior to requesting a On or Off ramp transaction

Operations

Eligibility
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Check eligibility for specific transactions

Operations

Limits
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Check payment method/customer limits

Operations

Banxa Enterprise API (0 BETA)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Ramps
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Identities
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Identity token sharing (sumsub)

Request

Responses

Was this helpful?

Identity Reliance

Request

Responses

Was this helpful?

Identity Document sharing

Request

Responses

Was this helpful?

Identity update

Request

Responses

Was this helpful?

Identity Retrieval

Request

Responses

Was this helpful?

Identity create

Request

Responses

Was this helpful?

Inbound message regarding customer Identity related messagesWebhook

Request

Responses

Was this helpful?

Price
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Eligibility
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Limits
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Banxa Enterprise API (0 BETA)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

RampsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

IdentitiesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Identity token sharing (sumsub)

RequestExpand all

Responses

Was this helpful?

Identity Reliance

RequestExpand all

Responses

Was this helpful?

Identity Document sharing

RequestExpand all

Responses

Was this helpful?

Identity update

RequestExpand all

Responses

Was this helpful?

Identity Retrieval

Request

Responses

Was this helpful?

Identity create

RequestExpand all

Responses

Was this helpful?

Inbound message regarding customer Identity related messagesWebhook

Request

Responses

Was this helpful?

PriceCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

EligibilityCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

LimitsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Banxa Enterprise API (0 BETA)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Ramps
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Identities
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request

Request

Request

Request

Request

Price
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Eligibility
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Limits
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude