NINVerificationResponse

  • country
    Type: string
    required
  • dateOfBirth
    Type: string | null
    required
  • error
    Type: object | null
    required

    Populated only when status is failed or error

    • code
      Type: string
      required
    • message
      Type: string
      required
  • firstName
    Type: string | null
    required
  • gender
    Type: string | null
    required
  • id
    Type: stringFormat: uuid
    required
  • identifier
    Type: string
    required
  • idType
    enum
    const:  
    nin
    required
    values
    • nin
  • lastName
    Type: string | null
    required
  • origin
    Type: stringenum
    required

    Where this verification was initiated. api = Lira API key (machine-to-machine). dashboard = logged-in dashboard user.

    values
    • api
    • dashboard
  • placeOfBirth
    Type: string | null
    required
  • status
    Type: stringenum
    required
    values
    • pending
    • success
    • failed
    • error
    • inconclusive
  • verificationType
    enum
    const:  
    NIN
    required
    values
    • NIN
  • verified
    Type: boolean | null
    required
  • verifiedAt
    Type: string | nullFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z