@bebapps/rapyd-sdk
Version:
An un-official [Rapyd](https://rapyd.net) SDK for Node.js.
83 lines (82 loc) • 2.31 kB
text/typescript
export interface AddContactToWalletRequest {
/**
* ID of the Rapyd Wallet that this contact is associated with. String starting with **ewallet_**.
*/
wallet: `ewallet_${string}`;
/**
* Address object or address ID, a string starting with **address_**..
*/
address?: object;
/**
* Type of contact: **personal**.
*/
contact_type: string;
/**
* 2-letter ISO 3166-1 ALPHA-2 code for the country. Uppercase.
*/
country?: string;
/**
* Date of birth of the individual. Format: MM/DD/YYYY
*/
date_of_birth?: string;
/**
* Email address for the contact.
*/
email?: string;
/**
* First name of the contact.
*/
first_name?: string;
/**
* Gender of the contact. One of the following values: **male**, **female**, **other**, **not_applicable**
*/
gender?: string;
/**
* Description of the type of residency. One of the following values: **lease**, **live_with_family**, **own**, **owner**, **month_to_month**, **housing_project**
*/
house_type?: string;
/**
* ID number as shown by the ID document. Alphanumeric string.
*/
identification_number?: string;
/**
* Type of the identification document. For valid types, use [List Official Identification Documents](ref:list-official-identification-documents).
*/
identification_type?: string;
/**
* Family name of the contact.
*/
last_name?: string;
/**
* Marital status of the contact. One of the following values: **married**, **single**, **divorced**, **widowed**, **cohabiting**, **not_applicable**
*/
marital_status?: string;
/**
* A JSON object defined by the client.
*/
metadata?: object;
/**
* Middle name of the personal contact or primary person associated with the business contact.
*/
middle_name?: string;
/**
* Name of the contact's mother.
*/
mothers_name?: string;
/**
* The citizenship of the contact. Two-letter ISO 3166-1 ALPHA-2 code for the country. Uppercase.
*/
nationality?: string;
/**
* Phone number of the contact in E.164 format.
*/
phone_number?: string;
/**
* Second last name of the contact.
*/
second_last_name?: string;
/**
* Determines whether Rapyd sends notifications to the contact. Default is **false**.
*/
send_notifications?: boolean;
};