🚀 VaultsPay API v1 is live. See what's new →
UsersUpdate KYC Identification Info

Update KYC Identification Info

Same fields as Create Identification but for updating existing identification records. Admin verifies and controls final kycStatus.

PATCH{baseUrl}/us/api/v1/kyc/identification

Payload

All fields are optional except userId (partial update).

AttributeTypeRequiredDescription
userIdIntegerYesTarget user ID.
selfieIdIntegerNoUploaded selfie file ID.
idFrontIdIntegerNoFront image file ID of ID card.
idBackIdIntegerNoBack image file ID of ID card.
idExpiryDateTimestamp (ISO 8601)NoID card expiry.
idNumberString (6–30)NoOfficial ID number.
idVerifiedBooleanNoWhether ID is verified.
passportIdIntegerNoPassport image file ID.
passportExpiryDateTimestampNoPassport expiry.
passportNumberString (6–9)NoPassport number.
passportVerifiedBooleanNoWhether passport is verified.
drivingLicenseIdIntegerNoDriving license image file ID.
drivingLicenseExpiryDateTimestampNoDriving license expiry.
drivingLicenseNumberString (6–20)NoDriving license number.
drivingLicenseVerifiedBooleanNoWhether driving license is verified.
residencePermitIdIntegerNoResidence permit image file ID.
residencePermitExpiryDateTimestampNoResidence permit expiry.
residencePermitNumberString (6–20)NoResidence permit number.
residencePermitVerifiedBooleanNoWhether residence permit is verified.
Request Example
{
  "userId": 602,
  "selfieId": 1,
  "idFrontId": 1,
  "idBackId": 1,
  "idExpiryDate": "2025-02-19T10:30:00Z",
  "idNumber": "ABC123XYZ",
  "idVerified": true,
  "passportId": 1,
  "passportExpiryDate": "2026-02-19T10:30:00Z",
  "passportNumber": "P123456",
  "passportVerified": true,
  "drivingLicenseId": 2,
  "drivingLicenseExpiryDate": "2027-05-10T15:00:00Z",
  "drivingLicenseNumber": "DL789456",
  "drivingLicenseVerified": false,
  "residencePermitId": 3,
  "residencePermitExpiryDate": "2028-08-22T12:45:00Z",
  "residencePermitNumber": "RP654321",
  "residencePermitVerified": true,
  "kycStatus": "VERIFIED"
}

Response

FieldTypeDescription
idIntegerIdentification record ID.
selfieObjectUploaded selfie metadata (id, name, originalName, mime, size, fileType, fileKey, privateAccessUrl, publicAccessUrl, createdAt, createdBy, updatedAt, updatedBy).
idFront / idBackObjectID card images metadata (same structure as selfie).
idExpiryDateString (ISO 8601)ID card expiry.
idNumberStringID number.
idVerifiedBooleanWhether ID card is verified.
passportObjectPassport image metadata.
passportExpiryDateStringPassport expiry.
passportNumberStringPassport number.
passportVerifiedBooleanWhether passport is verified.
drivingLicenseObjectDriving license image metadata.
drivingLicenseExpiryDateStringDL expiry.
drivingLicenseNumberStringDL number.
drivingLicenseVerifiedBooleanWhether DL is verified.
residencePermitObjectResidence permit image metadata.
residencePermitExpiryDateStringRP expiry.
residencePermitNumberStringRP number.
residencePermitVerifiedBooleanWhether RP is verified.
kycStatusEnumPENDING | VERIFIED | REJECTED (Admin-updated).