Create Individual Customer

To create an instance of a customer object, make a POST request to the /customers endpoint and provide the parameters required to create a customer.

Verb	URL
POST	{{baseUrl}}/api/v1/customers

The minimum requirement to create a customer include the: Full Name, address, email, phone number. However, to create a deposit account for this customer, additional KYC information such as BVN, date of birth and gender will be required.

You can include metadata as a key-value pair in your request as a means of saving information in our system.

Create Customer with Minimum Requirements

Below are sample request payload and response payload to create a customer with the minimum required details: Full name, address, email and phone number.

curl --location 'https://api.sandbox.getanchor.co/api/v1/customers' \
--header 'Content-Type: application/json' \
--header 'x-anchor-key: <API Key>' \
--data-raw '{
    "data": {
        "type": "IndividualCustomer",
        "attributes": {
            "fullName": {
                "firstName": "John",
                "lastName": "Smith",
                "middleName": "Edem",
                "maidenName": "joy"
            },
            "address": {
                "addressLine_1": "1, Ikeja Village Street",
                "addressLine_2": "1, Ikeja Village Street",
                "city": "Ikeja",
                "state": "Lagos",
                "postalCode": "123456",
                "country": "NG"
            },
            "email": "[email protected]",
            "phoneNumber": "07061234507",
            "metadata": {
                "my_customerID": "12345"
            }
        }
    }
}'

{
    "data": {
        "id": "170116154363520-anc_ind_cst",
        "type": "IndividualCustomer",
        "attributes": {
            "createdAt": "2023-11-28T08:52:23.640935",
            "metadata": {
                "my_customerID": "12345"
            },
            "phoneNumber": "07061234507",
            "address": {
                "addressLine_1": "1, Ikeja Village Street",
                "addressLine_2": "1, Ikeja Village Street",
                "country": "NG",
                "city": "Ikeja",
                "postalCode": "123456",
                "state": "Lagos"
            },
            "soleProprietor": false,
            "fullName": {
                "firstName": "John",
                "lastName": "Smith",
                "middleName": "Edem",
                "maidenName": "joy"
            },
            "email": "[email protected]",
            "verification": {
                "status": "unverified"
            },
            "status": "ACTIVE"
        },
        "relationships": {
            "documents": {
                "data": []
            },
            "organization": {
                "data": {
                    "id": "16922119849071-anc_og",
                    "type": "Organization"
                }
            }
        }
    }
}

Create Customer with KYC Level 2 Details

You can create an individual customer and provide the KYC Level 1 details. This means passing the required identificationLevel2 parameters which include: bvn, date of birth, and gender.

curl --location 'https://api.sandbox.getanchor.co/api/v1/customers' \
--header 'Content-Type: application/json' \
--header 'x-anchor-key: <API Key>' \
--data-raw '{
    "data": {
        "type": "IndividualCustomer",
        "attributes": {
            "fullName": {
                "firstName": "John",
                "lastName": "Smith",
                "middleName": "Edem",
                "maidenName": "Joy"
            },
            "address": {
                "addressLine_1": "1, Ikeja Village Street",
                "addressLine_2": "1, Ikeja Village Street",
                "city": "Ikeja",
                "state": "Lagos",
                "postalCode": "123456",
                "country": "NG"
            },
            "email": "[email protected]",
            "phoneNumber": "07061234509",
            "identificationLevel2": {
                "dateOfBirth": "1994-06-25",
                "gender": "Male",
                "bvn": "22222324206"
            },
            "metadata": {
                "my_customerID": "12345"
            }
        }
    }
}'

{
    "data": {
        "id": "170116649680221-anc_ind_cst",
        "type": "IndividualCustomer",
        "attributes": {
            "createdAt": "2023-11-28T10:14:56.834462",
            "metadata": {
                "my_customerID": "12345"
            },
            "phoneNumber": "07061234509",
            "address": {
                "addressLine_1": "1, Ikeja Village Street",
                "addressLine_2": "1, Ikeja Village Street",
                "country": "NG",
                "city": "Ikeja",
                "postalCode": "123456",
                "state": "Lagos"
            },
            "soleProprietor": false,
            "fullName": {
                "firstName": "John",
                "lastName": "Smith",
                "middleName": "Edem",
                "maidenName": "Joy"
            },
            "identificationLevel2": {
                "dateOfBirth": "1994-06-25",
                "gender": "Male",
                "bvn": "22222324206",
                "selfieImage": null
            },
            "email": "[email protected]",
            "verification": {
                "status": "unverified"
            },
            "status": "ACTIVE"
        },
        "relationships": {
            "documents": {
                "data": []
            },
            "organization": {
                "data": {
                    "id": "16922119849071-anc_og",
                    "type": "Organization"
                }
            }
        }
    }
}