Customer
Creating a customer
In MO, every customer will start as a pre-customer. After they meet the business rules to become a customer, for example, completing the onboarding process or accepting the terms and conditions, upgrade them to a customer.
Creating a pre-customer
To create a pre-customer, follow these steps:
- Make an API call to the Create pre-customer endpoint.
- Add the needed information to the request payload. The available fields of the payload are:
Field | Description | Required | Example |
---|---|---|---|
external_id | External identifier for the pre-customer. | No | YOUR_EXTERNAL_SYSTEM_ID |
first_name | First name of the pre-customer. | Yes | John |
last_name | Last name of the pre-customer. | Yes | Doe |
document_type | Type of document. | No | Passport |
document_number | Document number. | No | C03004783 |
phone | Phone number of the pre-customer. | No | +1 555-123-4567 |
email | Email address of the pre-customer. | Yes | [email protected] |
address | Address of the pre-customer. | No | 123 Main St, Cityville, State, 12345 |
- Send the request.
In the JSON response, you will receive the unique identifier of the created pre-customer. You can find it by accessing the data.id
property.
Upgrading to customer
After the customer above completes the onboarding process, accepting the terms and conditions, they are ready to be upgraded to customer. To do so, follow these steps:
- Make an API call to the Create customer endpoint.
- Add the needed information to the request payload, sending the
precustomer_id
. The available fields of the payload are:
Field | Description | Required | Example |
---|---|---|---|
precustomer_id | Identifier for the pre-existing customer. | Yes | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
external_id | External identifier for the customer. | No | YOUR_EXTERNAL_SYSTEM_ID |
first_name | First name of the customer. | Yes | John |
last_name | Last name of the customer. | Yes | Doe |
document_type | Type of document. | No | Passport |
document_number | Document number. | No | C03004783 |
phone | Phone number of the customer. | No | +1 555-123-4567 |
email | Email address of the customer. | Yes | [email protected] |
address | Address of the customer. | No | 123 Main St, Cityville, State, 12345 |
personal_accepted_at | Timestamp when personal agreement was accepted. | No | 2023-01-15T12:30:00Z |
commercial_accepted_at | Timestamp when commercial agreement was accepted. | No | 2023-01-15T13:00:00Z |
- Send the request.
The response JSON, similarly to the previous request, will return you the unique identifier of the created customer, which can be found inside the data.id
property.
As the customer is ready and created, they can apply for a credit loan.
Definition of customer status
- Unregistered: First automatic user status. In this status the user has not yet completed the registration process.
Actions allowed: complete the registration process through the platform. - Enabled: Proactive status that only applies when the user is eligible to apply for a loan. For example, they have no overdue or canceled loans, and have not committed any violations of business rules.
Actions allowed: make payments (automatic and voluntary) and requests for new loans through the platform. - Disabled: Automatic status in which the user is disabled to make new loan requests, may have a loan in default or may have committed violations of business rules..
Actions allowed: make payments (automatic and voluntary) through the platform. - Deleted: Proactive status where user information is permanently hidden from the platform. Hidden information: Names and Surnames, Phone Number, E-mail, Address, National ID..
Actions allowed: not applicable. - Blocked: Automatic status where the user is not allowed to submit new loan requests within the platform. The user's information remains stored in the platform and available for reference..
Actions allowed: payments outside the platform.
Updated 8 months ago