Skip to main content
Attach or update Know Your Customer (KYC) documents for a customer.

Endpoint

PUT https://api-v3.reeple.ai/customers/{id}/attach
ParameterTypeDescription
idStringRequired. The unique identifier of the customer account to update.

Request body

FieldTypeDescription
idTypeEnumRequired. NIN, PASSPORT, DRIVER_LICENSE, or VOTER_CARD.
idNumberStringRequired if idType is provided. Identification document number.
documentStringRequired if idType is provided. URL to the user’s identification document.
profileImageStringRequired if idType is provided. URL to the user’s profile image.
bvnStringConditionally required. Required when the customer’s country is NG.
dateOfBirthStringOptional. YYYY-MM-DD.

Country and currency support

This endpoint isn’t tied to a single transaction currency — it applies to customer identity verification across customer-linked flows.
RequirementApplies
BVNRequired when the customer country is NG
Identity document and profile imageRequired when customer identity data is being attached for verification

KYC and AML requirements

RequirementAppliesNotes
Customer identity documentYesRequired when attaching or updating KYC
Country-specific identity rulesYesNigeria requires BVN in the documented flow
AML reviewConditionalKYC quality affects whether downstream products can be issued or funded

Response

{
  "success": true,
  "statusCode": 200,
  "message": "Customer created successfully",
  "data": {
    "id": "326a18a1-441a-457d-ba28-0538e0717c92",
    "email": "test@example.com",
    "firstName": "test",
    "lastName": "testing",
    "city": "Bariga",
    "state": "Lagos",
    "country": "Nigeria",
    "zipCode": "100231",
    "line1": "123, Example 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": "Utility bill is older than 3 months",
    "businessId": "0bb1dfc6-a74c-4e53-b41a-4a0c1eab188e"
  }
}
Save the returned customer id — you’ll need it for bank account issuance, tuition payments, and other customer-linked endpoints.

Common errors

StatusMeaning
422Insufficient balance