Endpoints
GET/individual-Get list of all individual customers
POST/individual-Register a new individual
POST/individual/unblock/{id}- Only Update Status Of Individual Customer
POST/individual/whitelist/{id}- WhiteList Business Customer
GET/individual/{id}- Retrieve all details of an individual corresponding to an ID
PATCH/individual/{id}- Update individual
GET/individual/{id}/KYC- Retrieve identity verification for an individual customer
POST/individual/{id}/KYC- Create identity verification for an individual customer
Objects
-
ach: This object includes data regarding the individual's external bank account details. The external bank account will be used to deposit to / withdrawal from the individual's braid account.
accountNumber
: (string) The individual's bank account number.bankAccountType
: Type of the bank account (e.g., "CHECKING", "SAVINGS").bankName
: (string) Name of the individual's bank.routingNumber
: (string) The bank's routing number.
-
address: This object covers the individual's residential details:
city
: (string) City where the individual resides.line1
: (string) First line of the residential address - typically the street name.line2
: (string) Second line for further details of the address (if needed).state
: (string) State of the individual's residence.type
: Type of address (e.g., "MAILING").postalCode
: (string) The postal code of the individual's address.countryCode
: (string) The country code of the individual's address.
-
individual: This object encapsulates unique data specific to the individual, including personal and contact details:
dateOfBirth
: (string) Individual's date of birth, formatted according to ISO 8601 ("yyyy-mm-ddTHH:MM:SSZ").email
: (string) Personal email address of the individual.firstName
: (string) First name of the individual.idNumber
: (string) Identification number of the individual.idType
: (string) Type of identification used by the individual.lastName
: (string) Last name of the individual.middleName
: (string) Middle name of the individual (if any).mobilePhone
: (string) Individual's mobile phone number.
-
productId: (integer) Represents the product ID linked to the individual.
Parameters
Parameter | Type | Description |
---|---|---|
ach | Object | Holds the individual's bank account details |
- accountNumber | string | The individual's bank account number |
- bankAccountType | string | Type of the bank account (e.g. "SAVINGS") |
- bankName | string | The name of the individual's bank |
- routingNumber | string | The bank's routing number |
address | Object | Holds the individual's address details |
- city | string | The individual's city of residence |
- line1 | string | First line of the address, typically the street name |
- line2 | string | Additional address details, if any |
- state | string | The individual's state of residence |
- type | string | Type of the address (e.g. "MAILING") |
- postalCode | string | The address' postal code |
individual | Object | Holds the individual's personal and contact details |
- dateOfBirth | string | The individual's date of birth in ISO 8601 format |
string | The individual's email address | |
- firstName | string | The individual's first name |
- idNumber | string | The individual's identification number |
- idType | string | Type of identification used (e.g. "Passport") |
- lastName | string | The individual's last name |
- middleName | string | The individual's middle name |
- mobilePhone | string | The individual's mobile phone number |
productId | integer | The product ID associated with the individual |