Comment on page

Receive User Object

Read on how to add a receive user

Details
​
Field
Required
Type
Description
mobile_phone
Yes
Alpha-numeric
10 digits mobile number of the individual or 10-15 digits phone number of the business.
email
No
String
Email address of the user or business. This field may be required based on your spec sheet.
first_name
Yes
String
First name of the individual or name of the business.
middle_name
No
String
Middle name of the individual
last_name
Yes, if individual
String
Family name of the individual
gender
Conditional
String
Male, female, other. This field may be required based on your spec sheet. 
date_of_birth
Conditional
String
Birth date of individual or Day of formation for business in yyyy-MM-dd format. This field may be required based on your spec sheet.
business
Yes
Boolean
By default false. True if user is a business.
address_line1
Yes, if business receive user
String
Street address of the individual or registered address of the business. 
address_line2
No
String
Street address of the individual or registered address of the business.
city
Yes
String
City of residence of the individual or registered city of the business.
state
Yes, if business receive user
String
2-letter ISO code of the user's state. 
country
Yes
String
2-letter ISO code of user's country.
zipcode
Yes, if business receive user
String
Zip code of the user's address.
occupation
Conditional
String
User’s occupation. This field may be required based on your spec sheet.
type
Yes
Category
Enumerated Value : ‘SEND’ , ‘RECEIVE’
created_at
In Response
String
Date and time of user’s registration
physical_documents
Conditional
Object
Copy of a document. This field may be required based on your spec sheet.
physical_documents.document_type
Yes, if physical_document is required
String
Enumerated value. Note: Details provided below. 
physical_documents.document_value
Yes, if physical_document is required
String
Value of the document. Documents must be encoded Base64 before being uploaded to our system.
physical_documents.document_value_back
Conditional
String
Value of the rear side of the document. Documents must be encoded Base64 before being uploaded to our system.
physical_documents.country
Conditional
String
2-letter ISO code of the user’s country. 
physical_documents.state
Conditional
String
2-letter ISO code of the user’s state.
physical_documents.expiry_date
Conditional
String
Expiry date of document
virtual_documents
Conditional
Object
Identification document's information. This field may be required based on your spec sheet.
virtual_documents.document_type
Yes, if virtual_document is required
String
Enumerated value. Note: Details provided below. 
virtual_documents.document_value
Yes, if virtual_document is required
String
Value of the ID number. Example : Passport Number. 
virtual_documents.issue_date
Conditional
String
Date of issue of the document.
virtual_documents.expiry_date
Conditional
String
Date of expiry of the document.
virtual_documents.id_issuing_authority 
Conditional
String
ID issuing authority of the document. Please provide State if ID is DRIVING LICENSE or STATE ID and country if PASSPORT.
virtual_documents.country
Conditional
String
2-letter ISO code of the document issued country.
virtual_documents.state
Conditional
String
2-letter ISO code of the document issued state.
user_relationship
Conditional
String
Enumerated Value. Details provided below. This field may be required based on your spec sheet.
send_user_id
In Response
UUID
The ID of the send user who is registering the receive user to make a transfer.
​
User Relationship Enumerated Values
    AUNT("Aunt"),
    BROTHER("Brother"),
    BROTHER_IN_LAW("Brother in Law"),
    COUSIN("Cousin"),
    DAUGHTER("Daughter"),
    FATHER("Father"),
    FATHER_IN_LAW("Father in Law"),
    FRIENDS("Friends"),
    GRANDFATHER("Grand Father"),
    GRANDMOTHER("Grand Mother"),
    HUSBAND("Husband"),
    MOTHER("Mother"),
    MOTHER_IN_LAW("Mother in law"),
    NEPHEW("Nephew"),
    NIECE("Niece"),
    SELF("Self"),
    SISTER("Sister"),
    SISTER_IN_LAW("Sister in Law"),
    SON("Son"),
    UNCLE("Uncle"),
    WIFE("Wife"),
    OTHERS("Others")
​
Physical Document Type Enumerated Values
PASSPORT
DRIVING_LICENCE
STATE_ID
​
Virtual Document Type Enumerated Values
PASSPORT
DRIVING_LICENCE
STATE_ID
EIN_NUMBER
​
Please note that certain receive user information may be required based on the receiving country even though it may be outlined as optional in the API docs. Contact Machnet for a list of all the mandatory receive user information for your specific corridor.

CIP Information Status

Last modified 9mo ago

Field	Required	Type	Description
mobile_phone	Yes	Alpha-numeric	10 digits mobile number of the individual or 10-15 digits phone number of the business.
email	No	String	Email address of the user or business. This field may be required based on your spec sheet.
first_name	Yes	String	First name of the individual or name of the business.
middle_name	No	String	Middle name of the individual
last_name	Yes, if individual	String	Family name of the individual
gender	Conditional	String	Male, female, other. This field may be required based on your spec sheet.
date_of_birth	Conditional	String	Birth date of individual or Day of formation for business in yyyy-MM-dd format. This field may be required based on your spec sheet.
business	Yes	Boolean	By default false. True if user is a business.
address_line1	Yes, if business receive user	String	Street address of the individual or registered address of the business.
address_line2	No	String	Street address of the individual or registered address of the business.
city	Yes	String	City of residence of the individual or registered city of the business.
state	Yes, if business receive user	String	2-letter ISO code of the user's state.
country	Yes	String	2-letter ISO code of user's country.
zipcode	Yes, if business receive user	String	Zip code of the user's address.
occupation	Conditional	String	User’s occupation. This field may be required based on your spec sheet.
type	Yes	Category	Enumerated Value : ‘SEND’ , ‘RECEIVE’
created_at	In Response	String	Date and time of user’s registration
physical_documents	Conditional	Object	Copy of a document. *This field may be required based on your spec sheet.*
physical_documents.document_type	Yes, if physical_document is required	String	Enumerated value. Note: Details provided below.
physical_documents.document_value	Yes, if physical_document is required	String	Value of the document. Documents must be encoded Base64 before being uploaded to our system.
physical_documents.document_value_back	Conditional	String	Value of the rear side of the document. Documents must be encoded Base64 before being uploaded to our system.
physical_documents.country	Conditional	String	2-letter ISO code of the user’s country.
physical_documents.state	Conditional	String	2-letter ISO code of the user’s state.
physical_documents.expiry_date	Conditional	String	Expiry date of document
virtual_documents	Conditional	Object	Identification document's information. *This field may be required based on your spec sheet.*
virtual_documents.document_type	Yes, if virtual_document is required	String	Enumerated value. Note: Details provided below.
virtual_documents.document_value	Yes, if virtual_document is required	String	Value of the ID number. Example : Passport Number.
virtual_documents.issue_date	Conditional	String	Date of issue of the document.
virtual_documents.expiry_date	Conditional	String	Date of expiry of the document.
virtual_documents.id_issuing_authority	Conditional	String	ID issuing authority of the document. Please provide State if ID is DRIVING LICENSE or STATE ID and country if PASSPORT.
virtual_documents.country	Conditional	String	2-letter ISO code of the document issued country.
virtual_documents.state	Conditional	String	2-letter ISO code of the document issued state.
user_relationship	Conditional	String	Enumerated Value. Details provided below. This field may be required based on your spec sheet.
send_user_id	In Response	UUID	The ID of the send user who is registering the receive user to make a transfer.