Relation

Custodian Relationship Types

Valid options are:

  • parent

  • legal_guardian

POST /participants/customers/minor

const postParticipantMinor = () => {
  const body = {
    first_name: 'Gaurav',
    last_name: 'Mehta',
    email: 'gewgawrav@gmail.com',
    address_one: '1 Near CST',
    address_two: 'Fort Area',
    country: 'India',
    city: 'Mumbai',
    zip: '450001',
    state: 'MH',
    date_of_birth: '1989-10-13',
    id_number_type: 'aadhar_acardt',
    id_number: '123456789',
    non_us_other_type: null,
    id_issuing_authority: null,
    utma_signed_timestamp: 1603378501286,
    custodian_participant_code: 'CAST01',
    custodian_relationship: 'parent',
    metadata: {}
  }
  const timestamp = Math.round(Date.now() / 1000)
  const payload = timestamp + 'POST' + '/participants/customers/minor' + 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/minor`,
    options
  )
}

Sample Request

{
  "first_name": "Gaurav",
  "last_name": "Mehta",
  "email": "gewgawrav@gmail.com",
  "address_one": "1 Near CS",
  "address_two": "Fort Area",
  "country": "India",
  "city": "Mumbai",
  "zip": "450001",
  "state": "MH",
  "date_of_birth": "1989-10-13",
  "id_number_type": "aadhar_acard",
  "id_number": "123456789",
  "non_us_other_type": null,
  "id_issuing_authority": null,
  "utma_signed_timestamp": 1603378501286,
  "custodian_participant_code": "CAST01",
  "custodian_relationship": "parent",
  "metadata": {}
}

Submits a minor and links it to a custodian. Used in the context of the UTMA product.

Request body:

ParameterDescriptionType

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 "United States" 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

utma_signed_timestamp

The UNIX timestamp (in milliseconds) when the User Agreement UTMA Addendum was accepted by the custodian

timestamp

custodian_participant_code

The already-submitted participant code of the associated custodian

object

custodian_relationship

The type of custodian provided. if the field is filled, must be one of the supported custodian relationship

string

metadata

Can be used to submit any additional unstructed metadata

object

Additional fields in response:

ParameterDescriptionType

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

Supported Regions

NDAX operates in a limited regions. For more information, please contact us to learn more. Please refer to our disclosures page for more information on regional regulation.

ID Types

Valid options are:

  • aadhar_card

  • in_driving_license

  • in_passport

  • in_passport_card

  • non_in_passport

  • non_in_other

Sample Response

{
  "message": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "address_one": "string",
    "address_two": "string",
    "country": "string",
    "city": "string",
    "zip": "string",
    "state": "string",
    "date_of_birth": "string",
    "id_number_type": "ssn",
    "id_number": "string",
    "non_in_other_type": "string",
    "id_issuing_authority": "string",
    "utma_signed_timestamp": 0,
    "custodian_participant_code": "string",
    "participant_code": "string",
    "platform_code": "string",
    "custodian_relationship": "string",
    "metadata": {}
  }

Last updated