Sign in
Customers

Update Customer

put/v1/instances/{instance_id}/customers/{id}

Path parameters

instance_idstring required
Example:in_000000000000
idstring required
Example:re_000000000000

Headers

Idempotency-Keystring

Optional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

emailstring email required
tax_idstring nullable
address_line_1string nullable
address_line_2string nullable
citystring nullable
state_province_regionstring nullable
country'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'MK' | 'RO' | 'RU' | 'RW' | 'RE' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' required
postal_codestring nullable
ip_addressstring ip nullable
latitudenumber nullable

Optional geolocation latitude collected from the customer. Forwarded to AiPrise and SEON for fraud analysis.

longitudenumber nullable

Optional geolocation longitude collected from the customer. Forwarded to AiPrise and SEON for fraud analysis.

image_urlstring uri nullable
phone_numberstring nullable
proof_of_address_doc_type'UTILITY_BILL' | 'BANK_STATEMENT' | 'RENTAL_AGREEMENT' | 'TAX_DOCUMENT' | 'GOVERNMENT_CORRESPONDENCE' nullable
proof_of_address_doc_filestring uri nullable

Please upload one document that serve as proof of address, this needs to be the same physical address as the one provided above. Only PDF and image files are accepted (.jpg, .jpeg, .png, .pdf) with a maximum size of 3MB.

first_namestring nullable
last_namestring nullable
id_doc_country'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CI' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'MK' | 'RO' | 'RU' | 'RW' | 'RE' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' nullable
id_doc_type'PASSPORT' | 'ID_CARD' | 'DRIVERS' nullable
id_doc_front_filestring uri nullable

Only image files are accepted (.jpg, .jpeg, .png)

id_doc_back_filestring uri nullable

Only image files are accepted (.jpg, .jpeg, .png)

legal_namestring nullable
alternate_namestring nullable
websitestring uri nullable
incorporation_doc_filestring uri nullable

Please upload your articles of incorporation below. The articles of incorporation or a certificate of incorporation usually includes information like the company name, business purpose, number of shares offered, value of shares, etc. Only PDF and image files are accepted (.jpg, .jpeg, .png, .pdf) with a maximum size of 3MB.

proof_of_ownership_doc_filestring uri nullable

Please upload your proof of ownership below. This document usually includes information like the shareholders names and percentages. Only PDF and image files are accepted (.jpg, .jpeg, .png, .pdf) with a maximum size of 3MB.

source_of_funds_doc_type'business_income' | 'gambling_proceeds' | 'gifts' | 'government_benefits' | 'inheritance' | 'investment_loans' | 'pension_retirement' | 'salary' | 'sale_of_assets_real_estate' | 'savings' | 'esops' | 'investment_proceeds' | 'someone_else_funds' nullable
source_of_funds_doc_filestring uri nullable
selfie_filestring uri nullable

Only image files are accepted (.jpg, .jpeg, .png)

purpose_of_transactions'business_transactions' | 'charitable_donations' | 'investment_purposes' | 'payments_to_friends_or_family_abroad' | 'personal_or_living_expenses' | 'protect_wealth' | 'purchase_good_and_services' | 'receive_payment_for_freelancing' | 'receive_salary' | 'other' nullable
purpose_of_transactions_explanationstring nullable
account_purpose'charitable_donations' | 'ecommerce_retail_payments' | 'investment_purposes' | 'business_expenses' | 'payments_to_friends_or_family_abroad' | 'personal_or_living_expenses' | 'protect_wealth' | 'purchase_goods_and_services' | 'receive_payments_for_goods_and_services' | 'tax_optimization' | 'third_party_money_transmission' | 'payroll' | 'treasury_management' | 'other' nullable
account_purpose_otherstring nullable

Required when account_purpose is "other". Max 512 characters.

business_type'corporation' | 'llc' | 'partnership' | 'sole_proprietorship' | 'trust' | 'non_profit' nullable
business_descriptionstring nullable
business_industry'111998' | '112120' | '113310' | '115114' | '541211' | '541213' | '541219' | '541810' | '541430' | '541715' | '541930' | '561422' | '561311' | '561612' | '561740' | '561730' | '236115' | '236220' | '237310' | '238210' | '811111' | '812111' | '812112' | '532111' | '624410' | '541922' | '811210' | '812199' | '611110' | '611310' | '611410' | '611710' | '211120' | '212114' | '221310' | '562111' | '562920' | '213112' | '522110' | '522210' | '522320' | '523150' | '523940' | '523999' | '524113' | '813110' | '813211' | '813219' | '551112' | '721110' | '722511' | '722513' | '561510' | '713110' | '713210' | '712110' | '711110' | '711211' | '621111' | '621210' | '622110' | '623110' | '621511' | '623220' | '541940' | '621399' | '621910' | '541110' | '311421' | '337121' | '322220' | '339920' | '334210' | '339930' | '312130' | '334111' | '334118' | '325412' | '339112' | '336110' | '336390' | '315990' | '313110' | '339910' | '516120' | '513130' | '512250' | '519130' | '711410' | '711510' | '531110' | '531120' | '531130' | '531190' | '531210' | '531311' | '531312' | '531320' | '531390' | '454110' | '445110' | '455110' | '457110' | '449210' | '444110' | '459210' | '459120' | '445320' | '458110' | '458210' | '458310' | '455219' | '424210' | '456110' | '446120' | '541511' | '541512' | '541519' | '518210' | '511210' | '517111' | '517112' | '517410' | '481111' | '483111' | '485210' | '488510' | '484121' | '493110' | '423430' | '423690' | '423110' | '423830' | '423840' | '423510' | '424690' | '424990' | '424410' | '424480' | '423940' | '541611' | '541618' | '541330' | '541990' | '541214' | '561499' nullable
estimated_annual_revenue'0_99999' | '100000_999999' | '1000000_9999999' | '10000000_49999999' | '50000000_249999999' | '250000000_plus' nullable
source_of_wealth'business_dividends_or_profits' | 'investments' | 'asset_sales' | 'client_investor_contributions' | 'gambling' | 'charitable_contributions' | 'inheritance' | 'affiliate_or_royalty_income' nullable
publicly_tradedboolean nullable
occupationstring nullable
external_idstring nullable
tos_idstring nullable

Example request

{
  "email": "email@example.com",
  "tax_id": "536804398",
  "address_line_1": "738 Plain St",
  "address_line_2": "Building 22",
  "city": "Marshfield",
  "state_province_region": "MA",
  "country": "US",
  "postal_code": "02050",
  "ip_address": "127.0.0.1",
  "latitude": 37.7749,
  "longitude": -122.4194,
  "image_url": "https://example.com/image.png",
  "phone_number": "+13055555555",
  "proof_of_address_doc_type": "UTILITY_BILL",
  "proof_of_address_doc_file": "https://example.com/image.png",
  "first_name": "John",
  "last_name": "Doe",
  "id_doc_country": "BR",
  "id_doc_type": "PASSPORT",
  "id_doc_front_file": "https://example.com/image.png",
  "id_doc_back_file": "https://example.com/image.png",
  "legal_name": "Company Name Inc.",
  "alternate_name": "Company Name Inc.",
  "website": "https://example.com",
  "owners": [
    {
      "role": "beneficial_owner",
      "first_name": "John",
      "last_name": "Doe",
      "tax_id": "536804398",
      "address_line_1": "738 Plain St",
      "address_line_2": "Building 22",
      "city": "Marshfield",
      "state_province_region": "MA",
      "country": "US",
      "postal_code": "02050",
      "id_doc_country": "BR",
      "id_doc_type": "PASSPORT",
      "proof_of_address_doc_type": "UTILITY_BILL",
      "ownership_percentage": 25,
      "title": "CEO",
      "tax_type": "SSN"
    }
  ],
  "incorporation_doc_file": "https://example.com/image.png",
  "proof_of_ownership_doc_file": "https://example.com/image.png",
  "source_of_funds_doc_type": "business_income",
  "source_of_funds_doc_file": "https://example.com/image.png",
  "selfie_file": "https://example.com/image.png",
  "purpose_of_transactions": "business_transactions",
  "purpose_of_transactions_explanation": "I am a business owner and I want to receive payments from my customers",
  "account_purpose": "treasury_management",
  "account_purpose_other": "Custom account purpose description",
  "business_type": "llc",
  "business_description": "Software development company",
  "business_industry": "541511",
  "estimated_annual_revenue": "1000000_9999999",
  "source_of_wealth": "affiliate_or_royalty_income",
  "occupation": "Software Engineer",
  "external_id": "your_company_external_id",
  "tos_id": "to_000000000000",
  "additional_info": [
    {
      "label": "EIN_LETTER",
      "value": "https://example.com/ein.pdf"
    },
    {
      "label": "FLOW_OF_FUNDS",
      "value": "Funds originate from US payroll deposits, forwarded weekly to customer."
    }
  ]
}

Response

Customer updated

successboolean required

Example response

{
  "success": true
}

Changes

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