Sender Object
Last updated
Last updated
id
Response
UUID
Sender ID
first_name
Yes
string
The first name of the sender.
middle_name
No
string
The middle name of the sender.
last_name
Yes
string
The last name of the sender.
mobile_phone
Yes
string
10-15 digit mobile phone number of sender.
Yes
string
The email address of the sender.
state
Yes
string
2-letter ISO code of the sender's state.
nationality
No
string
3-letter ISO code of the sender's nationality. This field is not required during registration but may be required for KYC/transaction payout based on your spec sheet.
If required for KYC, this field will be collected through the or needs to be collected using the .
If only required for transaction payout, this field can be updated for a user using the as long as the field is null. However, transaction delivery will be placed on HOLD if the field is not provided before transaction creation.
current_tier
Response
string
Enumerated value LEVEL1
, LEVEL2
, LEVEL3
.
status
Response
string
Sender's KYC status defined by enumerated value VERIFIED
, IN_PROGRESS
, UNVERIFIED
, DOCUMENT
, SUSPENDED
, RETRY
, REUPLOAD
, REVIEW_PENDING
, RETRY_REQUESTED
, DOCUMENT_REQUESTED
.
requested_fields
Response
list
List of field information if required by admin for sender kyc process. Enumerated value SENDER_ID_INFO
, SENDER_SOURCE_OF_FUND
, SENDER_PROOF_OF_ADDRESS
, SENDER_FULL_SSN
.
cip_failure_reasons
Response
list
List of reasons in case of sender kyc failure.