Add Customer

The "Add Customer" endpoint is a vital component of our API, designed to facilitate the creation and storage of new customer records within the system.

The POST {{baseUrl}}/customer endpoint is designed to facilitate the creation and storage of new customer records within the system. This endpoint allows applications to efficiently add customer data, ensuring that new customer information is accurately recorded for subsequent use. It supports various use cases, including registering new users, onboarding clients, and integrating customer data from other systems.

Key Features:

  • HTTP Method: POST

  • Endpoint URL: {{baseUrl}}/customer

  • Authentication: Requires Bearer token to ensure secure access.

  • Request Payload: Accepts a JSON object containing detailed customer information, such as name, email, phone number, address, and identification details.

  • Note the customer Identity Document information will not be available after this request.

Create a new user

POST /customer

Headers

Body

{
    "customer_name": "Test Customer",
    "customer_email": "test_customer@yativo.com",
    "customer_phone": "+19203751411",
    "customer_country": "USA",
    "customer_address": {
        "city": "Anytown",
        "state": "Anystate",
        "zipcode": "12345",
        "street": "1234 Elm Street",
        "number": "5678",
        "country": "USA"
    },
    "customer_idType": "PASSPORT",
    "customer_idNumber": "A10600011",
    "customer_idCountry": "Chile",
    "customer_idExpiration": "04/24",
    "customer_idFront": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/wcAAgMBAZ8AItQAAAAASUVORK5CYII=", // base64_encode image
    "customer_idBack": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/wcAAgMBAZ8AItQAAAAASUVORK5CYII=" // base64_encode image
}

Response

{
    "status": "success",
    "status_code": 201,
    "message": "Request successful",
    "data": {
        "customer_id": "5ae2f659-45d2-4256-9f82-2811726a5376",
        "customer_name": "Test Customer",
        "customer_email": "test_customer5@yativo.com",
        "customer_phone": "+19203751411",
        "customer_country": "USA",
        "customer_address": {
            "city": "Anytown",
            "state": "Anystate",
            "zipcode": "12345",
            "street": "1234 Elm Street",
            "number": "5678",
            "country": "USA"
        }
    }
}

Last updated