Sign in
Customers

Retrieve Customers

get/v1/instances/{instance_id}/customers

Path parameters

instance_idstring required
Example:in_000000000000

Query parameters

limit'10' | '50' | '100' | '200' | '500' | '1000'

Number of items to return

Example:50
offset'0' | '10' | '50' | '100' | '200' | '500' | '1000'

Number of items to skip

Example:0
starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list.

Example:pi_123
ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list.

Example:pi_123
full_namestring
customer_namestring
status'verifying' | 'approved' | 'rejected' | 'deprecated' | 'pending_review' | 'awaiting_contract' | 'compliance_request' | 'approved_rfi'
customer_idstring
bank_account_idstring
countrystring

Response

List customers with pagination

OR

Example response

{
  "data": [
    {
      "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."
        }
      ]
    }
  ],
  "pagination": {
    "has_more": true,
    "next_page": "pi_123",
    "prev_page": "pi_123"
  }
}

Changes

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