Customers

Retrieve Customer

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

Path parameters

instance_idstring required

Example:in_000000000000

idstring required

Example:re_000000000000

Response

Get customer

idstring required

customer_idstring required

type'individual' | 'business' required

kyc_type'light' | 'standard' | 'enhanced' required

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 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 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 nullable

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

id_doc_back_filestring nullable

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

legal_namestring nullable

alternate_namestring nullable

websitestring uri nullable

incorporation_doc_filestring 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 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_filestring nullable

selfie_filestring nullable

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

purpose_of_transactions_explanationstring nullable

is_fboboolean nullable

account_purpose_otherstring nullable

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

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

publicly_tradedboolean nullable

occupationstring nullable

external_idstring nullable

instance_idstring required

tos_idstring nullable

aml_status'clear' | 'hit' | 'error' nullable

AML screening status from SEON. null = not yet screened.

created_atstring date-time nullable

updated_atstring date-time nullable

is_tos_acceptedboolean nullable

Example response

{
  "id": "re_000000000000",
  "customer_id": "re_000000000000",
  "type": "individual",
  "kyc_type": "standard",
  "kyc_status": "verifying",
  "kyc_warnings": [
    {
      "code": "BIRTH_DATE_MISMATCH",
      "message": "Mismatch between supplied birth date and extracted/looked up birth date.",
      "resolution_status": "UNRESOLVED",
      "warning_id": "38170889-50aa-4271-9eb1-61113ebf408c"
    }
  ],
  "fraud_warnings": [
    {
      "id": "UC114",
      "name": "User never used a Datacenter proxy and this device before",
      "operation": "+",
      "score": 10
    }
  ],
  "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": [
    {
      "id": "ub_000000000000",
      "first_name": "John",
      "last_name": "Doe",
      "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",
      "id_doc_front_file": "https://example.com/image.png",
      "id_doc_back_file": "https://example.com/image.png"
    }
  ],
  "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",
  "instance_id": "in_000000000000",
  "tos_id": "to_000000000000",
  "aml_status": "clear",
  "aml_hits": {
    "has_sanction_match": false,
    "has_pep_match": false,
    "has_watchlist_match": false,
    "has_crimelist_match": false,
    "has_adversemedia_match": false
  },
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "limit": {
    "per_transaction": 100000,
    "daily": 200000,
    "monthly": 1000000
  },
  "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."
    }
  ]
}

Changes

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