POST New

POST /participants/customers/new

const postParticipantCustomer = () => {
  const body = {
    request_id: "7fbab305-2679-4279-808b-9b7a63a55c85",
    first_name: "Gaurav",
    last_name: "Mehta",
    address_one: "Near CST",
    address_two: "Fort",
    country: "India",
    signed_timestamp: "1603378501286",
    email: "[e-mail]",
    metadata: {},
    state: "MH",
    city: "MUMBAI",
    date_of_birth: "1989-10-13",
    id_number_type: "Passport",
    id_number: "123456789",
    zip: "12345",
    prefunded: false
  }
  const timestamp = Math.round(Date.now() / 1000)
  const payload = timestamp + 'POST' + '/participants/customers/new' + JSON.stringify(body)
  const decodedSecret = Buffer.from(apiSecret, 'base64')
  const hmac = crypto.createHmac('sha256', decodedSecret)
  const signedPayload = hmac.update(payload).digest('base64')

  // SET HEADERS
 const headers = {
    'X-NDAX-API-KEY': 'public_key',
    'X-NDAX-SIGNED': signedPayload,
    'X-NDAX-TIMESTAMP': timestamp,
    'X-NDAX-PASSPHRASE': 'passphrase'
  }
  const options = {
    headers,
    body,
    json: true
  }

  return request.post(
    `https://api.ndax.in/participants/customers/new`,
    options
  )
}

Sample Request

{
  "request_id": "7fbab305-2679-4279-808b-9b7a63a55c85",
  "first_name": "John",
  "last_name": "Smith",
  "email": "[e-mail]",
  "address_one": "1 Main St.",
  "address_two": "Suite 1000",
  "city": "Chicago",
  "state": "IL",
  "zip": "12345",
  "country": "United States",
  "date_of_birth": "1985-09-02",
  "id_number_type": "ssn",
  "id_number": "123456789",
  "signed_timestamp": 1603378501286,
  "prefunded": false,
  "metadata": {}
}

Sample Response

{
  "message": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "[e-mail]",
    "address_one": "1 Main St.",
    "address_two": "Suite 1000",
    "country": "United States",
    "state": "IL",
    "city": "Chicago",
    "zip": "12345",
    "date_of_birth": "1985-09-02",
    "id_number_type": "ssn",
    "id_number": "123456789",
    "non_us_other_type": null,
    "id_issuing_authority": null,
    "signed_timestamp": 1603378501286,
    "risk_rating": null,
    "metadata": {},
    "platform_code": "ABC123",
    "participant_code": "XYZ456"
  }
}

This endpoint is only available to certain participants leveraging NDAX for customer settlements. Please contact us for more information on enabling this endpoint.

Submits a customer to your platform.

Request body:

Parameter	Description	Type
request_id	A universally unique identifier (UUID) for this request, optional Note: To ensure idempotence, it is recommended to include this parameter	string
first_name	The first name of the customer, required	string
last_name	The last name of the customer, required	string
email	Customer email address, required Note: NDAX will validate that the email is a correctly formatted email, and that the value is unique per-platform	string
address_one	First line for the customer's address, required Note: PO Box addresses are not accepted	string
address_two	First line for the customer's address, if applicable, optional	string
city	The city customer resides in, required	string
state	The state the customer resides in, required if country is "India" Note: must be one of the supported states	string
zip	Zip code of the customer in the format <5digits> or <5digits>-<4digits>, e.g. 77777 or 77777-7777, required if country is "United States"	string
country	The country the customer resides in, required Note: must be one of the supported countries.	string
date_of_birth	Date of birth of the customer in the format YYYY-MM-DD, required	string
id_number_type	The type of ID document provided, required Note: must be one of the supported ID types	string
id_number	The ID number for the customer, required	string
non_us_other_type	This is required if you select non_us_other for the id_number_type - a freeform string to describe the ID type	string
id_issuing_authority	The issuing authority for the ID, if available, optional	string
risk_rating	The risk-rating associated with the customer, conditionally required for certain platforms	string
signed_timestamp	The UNIX timestamp (in milliseconds) when the NDAX Services Agreement was accepted by the participant	timestamp
prefunded	Indicates if a customer will be credit checked through their own account or through an omnibus account	boolean
metadata	Can be used to submit any additional unstructed metadata	object

Additional fields in response:

Parameter	Description	Type
platform_code	The unique identifier for the Platform onto which the customer has been created	string
participant_code	The NDAX identifier for the new customer Note: this value is key to enable you to submit trades and check account balances for this customer	string

Possible Responses:

Status Code	Description
200 OK	The customer was successfully created. Note: the request is idempotent only IF therequest_id and payload is the same as previously submitted
400 Bad Request	The request is invalid, OR the payload is the same as a previously submitted request, but the request_id is different, OR, the request_id is the same as a previously submitted request, but the payload is different