Skip to main content

Contact

Properties

NameTypeRequiredDescription
addressAddressaddress associated with this specific Rapyd entity Payment/Customer etc...
business_detailsContactBusiness
compliance_profilefloatIndicates the degree to which this contact can use the wallet.
contact_typeContactTypeType of contact.
countrystr
created_atfloat
date_of_birthstrDate of birth of the individua
emailstrEmail address of the contact
ewalletstrID of the Rapyd Wallet that this contact is associated with. String starting with ewallet_.
first_namestrFirst name of the personal contact or primary person associated with the business contact.
genderGenderGender of the personal contact or primary person associated with the business contact
house_typeHouseTypeDescription of the type of residency at the contact's residence.
id_strID of the contact object. String starting with cont_.
identification_numberstrID number as shown by the ID document.
identification_typestrType of the identification document associated with the contact. Uppercase.
issued_card_datadictDescribes additional information about the business contact for a company wallet.
last_namestrFamily name of the personal contact or primary person associated with the business contact. Required for issuing a card to a personal contact.
marital_statusMaritalStatusMarital status of the personal contact or primary person associated with the business contact.
metadatadictA JSON object defined by the client.
middle_namestrMiddle name of the personal contact or primary person associated with the business contact.
mothers_namestrName of the contact's mother
nationalitystr
phone_numberstrPhone number of the contact in E.164 format.
second_last_namestrSecond last name of the personal contact or primary person associated with the business contact.
send_notificationsboolDetermines whether Rapyd sends notifications to the contact. Default is false.
verification_statusVerificationStatusResult of the verification check.
contact_reference_idstrReference ID for the contact. Limited to 45 characters. Should be unique per merchant per e-wallet.

ContactType

Type of contact.

Properties

NameTypeRequiredDescription
PERSONALstr"personal"
BUSINESSstr"business"

Gender

Gender of the personal contact or primary person associated with the business contact

Properties

NameTypeRequiredDescription
MALEstr"male"
FEMALEstr"female"
OTHERstr"other"
NOTAPPLICABLEstr"not_applicable"

HouseType

Description of the type of residency at the contact's residence.

Properties

NameTypeRequiredDescription
LEASEstr"lease"
LIVEWITHFAMILYstr"live_with_family"
OWNstr"own"
OWNERstr"owner"
MONTHTOMONTHstr"month_to_month"
HOUSINGPROJECTstr"housing_project"

MaritalStatus

Marital status of the personal contact or primary person associated with the business contact.

Properties

NameTypeRequiredDescription
MARRIEDstr"married"
SINGLEstr"single"
DIVORCEDstr"divorced"
WIDOWEDstr"widowed"
COHABITINGstr"cohabiting"
NOTAPPLICABLEstr"not_applicable"

VerificationStatus

Result of the verification check.

Properties

NameTypeRequiredDescription
NOTVERIFIEDstr"not verified"
KYCDstr"KYCd"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →