Create a customer

Customers are how the API links resources, such as cards or bank accounts, to the holder. You need to create customers before you can issue cards or assign bank accounts. You can create either individuals or businesses as customers.

Individuals

You can create an individual as a customer like so:

Sample Request

curl https://api.allawee.com/customers
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-d '{
  "name": "string",
  "reference": "[email protected]",
  "type": "individual",
  "claims": {
    "individualInformation": {
      "title": "string",
      "gender": "M",
      "nationalityCode": "NG",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phoneNumber": "+2348123456789",
      "dateOfBirth": "string",
      "email": "[email protected]"
    },
    "individualAddress": {
      "city": "Yaba",
      "state": "Lagos",
      "countryCode": "NG",
      "addressLineOne": "No 10, Adekunle Close",
      "addressLineTwo": "Off Ciroma Rd"
    },
    "individualIdentity": {
      "type": "bvn",
      "id": "A015BVP13Z",
      "url": "https://example.com/document.png",
      "issuingCountry": "NG"
    },
  },
  "verifications": [
    "string"
  ],
  "metadata": {}
}'
-X POST

Request Body parameter	Required?	Description
name	Yes	The customer’s legal name. If it is a business, it should be the business’s registration name.
reference	Yes	A unique reference for the customer. It could be the ID you use to identify the customer within your system or an email.
type	Yes	This value should be either individual or business and identifies whether the customer is a natural person or a business entity.
claims	Yes	This field contains the customer’s KYC information.
verifications	Yes	This represents the verification tier of the customer. It may be tier-1, tier-2, or tier-3.
metadata	Yes	This is an object value you can use to store any values you wish to associate with the customer.

Sample Success Response

{
    "code": "success",
    "data": {
        "name": "Ciroma C Adekunle",
        "type": "individual",
        "status": "active",
        "claims": {
            "individualInformation": {
                "firstName": "Ciroma",
                "lastName": "Adekunle",
                "middleName": "Chukwuma",
                "email": "[email protected]",
                "phoneNumber": "+2349154109234",
                "title": "Mr",
                "gender": "M",
                "dateOfBirth": "1997-2-13",
                "nationalityCode": "NG"
            },
            "individualAddress": {
                "city": "Yaba",
                "state": "NG-LA",
                "countryCode": "NG",
                "addressLineOne": "100 herbert macaulay road",
                "addressLineTwo": "",
                "postalCode": "11041"
            },
            "individualIdentity": {
                "type": "bvn",
                "id": "22489035167",
                "issuingCountry": "NG"
            }
        },
        "verifications": [
            {
                "type": "tier-2",
                "status": "verified"
            }
        ],
        "metadata": {
            "userId": 2345
        },
        "createdAt": "2023-03-14T23:21:12.882Z",
        "updatedAt": "2023-03-14T23:21:12.882Z",
        "id": "cus.2tXNjMhytgx7hCxu9",
        "object": "customer"
    }
}

Corporate customers

You can create a corporate customer like so:

Sample Request

curl https://api.allawee.com/customers
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-d '{
  "name": "string",
  "reference": "[email protected]",
  "type": "individual",
  "claims": {
    "businessInformation": {
      "registrationName": "Good Mill Ltd",
      "phoneNumber": "+2348123456789",
      "email": "[email protected]"
    },
    "businessIdentity": {
      "type": "cac",
      "id": "A015BVP13Z",
      "url": "https://example.com/document.png",
      "issuingCountry": "NG"
    },
    "businessDirectors": [
      "string"
    ],
    "businessAddress": {
      "city": "Yaba",
      "state": "Lagos",
      "countryCode": "NG",
      "addressLineOne": "No 10, Adekunle Close",
      "addressLineTwo": "Off Ciroma Rd"
    }
  },
  "verifications": [
    "string"
  ],
  "metadata": {}
}'
-X POST