Customer Account Creation

This API allows you to create and manage user accounts efficiently and securely. With this API, you can streamline the onboarding process, ensuring a seamless experience for your users.

To create an account, make a POST request to the endpoint:

{{baseurl}}/customers/create

These are the parameters of the request body.

FieldData TypeDescription
cityStringRequired. User’s city of residence.
countryStringRequired. User’s country of residence.
dateOfBirthStringRequired. User’s date of birth.
emailStringRequired. User’s email address.
firstNameStringRequired. User’s first name
idTypeObjectRequired. Type of identification document.
lastnameStringRequired. User’s last name.
line1StringRequired. First line of user’s address.
line2StringRequired. Second line of user’s address.
phoneNumberStringRequired. User’s phone number.
referenceStringRequired. Reference identifier for the user.
stateStringRequired. User’s state of residence.
zipCodeStringRequired. User’s postal or ZIP code
documentStringOptional. Document related to the user.
houseStringOptional. House or apartment number
idNumberStringOptional. Identification document number.
profileImageStringOptional. URL to user’s profile image.

This is what a typical successful response will look like:

{
  "success": true,
  "statusCode": 201,
  "message": "Customer created successfully",
  "data": {
    "id": "326a18a1-441a-457d-ba28-0538e0717c92",
    "email": "test@payshiga.com",
    "firstName": "test",
    "lastName": "testing",
    "city": "Bariga",
    "state": "Lagos",
    "country": "Nigeria",
    "zipCode": "100231",
    "line1": "123, Payshiga road",
    "line2": null,
    "phoneNumber": "+2348123456789",
    "house": "Zk9",
    "dateOfBirth": "2002-10-29T00:00:00.000Z",
    "idType": null,
    "idNumber": null,
    "document": null,
    "imageURL": null,
    "reference": "w72hs8shshshshw8s8292ushs",
    "createdAt": "2024-05-01T22:10:44.329Z",
    "status": "UNVERIFIED",
    "reason": null,
    "businessId": "0bb1dfc6-a74c-4e53-b41a-4a0c1eab188e"
  }
}

Error Responses

Missing API keys

Status Code: 401 Bad Request

The response will include an error message indicating an issue with the request parameters.

// Some code