VerifyIdentityRequest

  • country
    Type: string
    min length:  
    2
    max length:  
    2
    required

    ISO 3166-1 alpha-2 country code. Currently supported: NG.

  • idNumber
    Type: string
    min length:  
    1
    required

    Identity document number. For BVN: exactly 11 digits.

  • idType
    Type: string
    min length:  
    2
    max length:  
    30
    required

    Identity document type. For NG: bvn.

  • mode
    Type: stringenum

    sync returns the verification result in the response. async returns pending and delivers the final result via your registered webhooks (configure under /webhooks).

    values
    • sync
    • async
  • validation
    Type: object

    Optional fields to cross-check against the registry response. When provided, the verification fails if values do not match.

    • dateOfBirth
      Type: string Pattern: ^\d{4}-\d{2}-\d{2}$

      Format YYYY-MM-DD

    • firstName
      Type: string
    • lastName
      Type: string
    • selfie
      Type: string

      Base64-encoded selfie image for biometric match (data URI or raw base64)