v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Individual Participants

Create customer

Submits a customer to your platform. This endpoint is only available to certain participants leveraging zerohash for customer settlements. Please contact us for more information on enabling this endpoint.

post/participants/customers/new

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Request body

OR
OR
OR
OR

Example request

{
  "first_name": "John",
  "middle_name": "Middle",
  "last_name": "Smith",
  "email": "test@example.com",
  "phone_number": "15557778888",
  "citizenship_code": "US",
  "place_of_birth": {
    "country_code": "NL",
    "place_name": "Amsterdam"
  },
  "date_of_birth": "1985-09-02",
  "address_one": "123 Main St.",
  "address_two": "Suite 1000",
  "city": "Chicago",
  "postal_code": "12345",
  "tax_id": "000-00-0000",
  "id_number": "123456789",
  "id_issuing_date": "2020-12-16",
  "id_expiration_date": "2026-12-25",
  "signed_timestamp": 1603378501286,
  "sanction_screening_timestamp": 1603378501286,
  "jurisdiction_code": "US-IL",
  "kyc": "pass",
  "kyc_timestamp": 1603378501286,
  "sanction_screening": "pass",
  "idv": "pass",
  "liveness_check": "pass",
  "employment_status": "full_time",
  "industry": "adult_entertainment",
  "source_of_funds": "salary",
  "salary": "under_3500",
  "savings_and_investments": "under_10000",
  "tx_equivalent_annual_volume": "25k_to_100k",
  "tx_frequency_of_use": "up_to_12",
  "tx_type_of_service": [
    "buy_crypto",
    "sell_crypto"
  ],
  "tx_relationship_term_with_service": "long_term",
  "tx_relationship_term_with_service_other_explanation": "some free form explanation here in case of other type of tx_relationship_term_with_service",
  "signed_agreements": [
    {
      "type": "user_agreement",
      "region": "us",
      "signed_timestamp": 1603378501286
    }
  ],
  "self_certification_timestamp": 1667504636159,
  "tax_residence": {
    "jurisdiction_code": "PT-11"
  },
  "tin_jurisdiction_reason": "working_abroad",
  "proof_of_address_coordinates": {
    "latitude": "N 51d 30.000000m 40.190000",
    "longitude": "W 0d 4.100000m 59.940000"
  }
}

Response

Successfully created customer participant. Returns the created resource with generated IDs and timestamps.

Example response

{
  "message": {
    "first_name": "John",
    "middle_name": "Middle",
    "last_name": "Smith",
    "former_name": "Whale",
    "email": "test@example.com",
    "phone_number": "15557778888",
    "address_one": "123 Main St.",
    "address_two": "Suite 1000",
    "country": "USA",
    "city": "Chicago",
    "zip": "12345",
    "postal_code": "12345",
    "jurisdiction_code": "US-IL",
    "citizenship_code": "US",
    "date_of_birth": "1985-09-02",
    "tax_id": "000-00-0000",
    "id_number_type": "us_passport",
    "id_number": "123456789",
    "signed_timestamp": 1603378501286,
    "metadata": {},
    "kyc": "pass",
    "kyc_timestamp": 1603378501286,
    "onboarding_profile": "kyc_track",
    "onboarded_location": "US-FL",
    "sanction_screening": "pass",
    "sanction_screening_timestamp": 1603378501286,
    "idv": "pass",
    "liveness_check": "pass",
    "employment_status": "full_time",
    "industry": "adult_entertainment",
    "source_of_funds": "salary",
    "signed_agreements": [
      {
        "type": "user_agreement",
        "region": "us",
        "signed_timestamp": 1603378501286
      }
    ],
    "salary": "under_3500",
    "savings_and_investments": "under_10000",
    "investor_category": "restricted",
    "distribution_channel": "XYZ",
    "ip_address": "10.132.5.50",
    "place_of_birth": {
      "country_code": "NL",
      "place_name": "Amsterdam"
    },
    "id_expiration_date": "2026-12-25",
    "id_issuing_date": "2020-12-16",
    "tx_equivalent_annual_volume": "25k_to_100k",
    "tx_frequency_of_use": "up_to_12",
    "tx_type_of_service": [
      "buy_crypto",
      "sell_crypto"
    ],
    "tx_relationship_term_with_service": "long_term",
    "tx_relationship_term_with_service_other_explanation": "some free form explanation here in case of other type of tx_relationship_term_with_service",
    "gender": "male",
    "purpose_of_transactions": "payments_personal",
    "purpose_of_transactions_other_explanation": "some free form explanation here in case of other type of purpose_of_transactions",
    "expected_monthly_transaction_count": "between_11_and_100",
    "expected_usd_equivalent_daily_volume": "between_1001_and_10000",
    "gross_annual_salary_amount": "10000",
    "self_certification_timestamp": 1667504636159,
    "tax_residence": {
      "jurisdiction_code": "PT-11"
    },
    "tin_jurisdiction_reason": "working_abroad",
    "additional_tax_residences": [
      {
        "jurisdiction_code": "US-IL"
      }
    ],
    "proof_of_address_coordinates": {
      "latitude": "51.511164",
      "longitude": "-0.083317"
    },
    "b_notice_receipt": true,
    "is_w_form_certified": true,
    "w_form_certification": 1667504636159,
    "signature": "signature_data",
    "signature_timestamp": 1667504636159,
    "payee_exemption": "NONE",
    "fatca_reporting_exemption": "NONE",
    "platform_code": "XXXXXX",
    "participant_code": "XXXXXX",
    "status": "approved"
  }
}