Basic Information

This document has two types:

  1. BASIC_INFO: Details corresponding to the User
  2. JOINT_BASIC_INFO: Details corresponding to the Joint account holder linked to this User

When creating Joint accounts on the platform, both of these documents should be provided on the User object.

Attribute

Type

Description

Required

type

string

Type of user document. Default to "BASIC_INFO"

data

object

Document object that contains all data for the "BASIC_INFO" user document

data.firstName

string

First name, when displaying in your mobile application please list as Legal Name

data.lastName

string

Last name

data.country

string

Country which user resides. Follows the ISO 3166-1 alpha-3 standard. Use Countries API for listing of all countries

data.phone

string

Phone number

data.emailAddress

string

Email address

data.language

string

Language of user. Options:

  • "en_US" – English
  • "zh_CN" – Chinese
  • "es_ES" – Spanish
  • "pt_BR" – Portuguese

{
  "type": "BASIC_INFO",
  "data": {
    "firstName": "Veronica",
    "lastName": "Mars",
    "country": "USA",
    "phone": "2125551234",
    "emailAddress": "[email protected]",
    "language": "en_US"
  }
}