​
Attach KYC

This API endpoint is used to securely attach or update Know Your Customer (KYC) documents for a customer.

​
Endpoint

PUT {{baseurl}}/customers/{id}/attach

Method: PUT

There is just one parameter required here: ID, which is the unique identifier of the customer account you want to retrieve.

Here is the payload:

FieldData TypeDescription
idTypeEnum

Required. Type of identification document. Values: NIN, PASSPORT, DRIVER_LICENSE, VOTER_CARD.

idNumberString

Required. Identification document number. Required if idType is provided.

documentString

Optional. URL to the user’s identification document. Required if idType is provided.

profileImageString

Optional. URL to the user’s profile image. Required if idType is provided.

bvnString

Conditionally Required. BVN is required if the country is NG (Nigeria).

dateOfBirthString

Optional. User’s date of birth in YYYY-MM-DD format.

Here’s what the sample response to the request to update KYC details would look like:

{
    "success": true,
    "statusCode": 200,
    "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": "+2348131911964",
        "house": "Zk9",
        "dateOfBirth": "2002-10-29T00:00:00.000Z",
        "idType": "NIN",
        "idNumber": "123456789",
        "document": "https://example.com/document.pdf",
        "imageURL": "https://example.com/profile.jpg",
        "reference": "w72hs8shshshshw8s8292ushs",
        "createdAt": "2024-05-01T22:10:44.329Z",
        "status": "REJECTED",
        "reason": "Utitlity bill is older than 3 months",
        "businessId": "0bb1dfc6-a74c-4e53-b41a-4a0c1eab188e"
    }
}

Remember to save the customer ID

​
Error Responses

​
Missing API keys

Status Code: 422 Bad Request

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

{
    "status": false,
    "statusCode": 422,
    "message": "Insufficient Balance"
}
Customer account creationList customer accounts