# Receive User Object

{% tabs %}
{% tab title="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
```

{% hint style="info" %}
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.
{% endhint %}
{% endtab %}
{% endtabs %}