GovCheck: Ghana Verify Card (Facematch)

Validates national identity information and performs biometric face verification against the government’s biometric database.

Webhook response

{
  "data": {
    "personalNumber": "GHA-000000000-0",
    "documentNumber": "AV0000000",
    "cardValidFrom": "2022-02-09",
    "cardValidTo": "2032-02-08",
    "surname": "SURNAME",
    "forenames": "FORENAME",
    "nationality": "Ghana",
    "birthDate": "1999-05-14",
    "gender": "male",
    "birthCountry": null,
    "birthDistrict": null,
    "birthRegion": null,
    "birthTown": null,
    "addresses": [
      {
        "type": "Hometown",
        "community": null,
        "town": "TOWN NAME",
        "countryName": "COUNTRY NAME",
        "districtName": "DISTRICT NAME",
        "region": "REGION",
        "postalCode": null,
        "addressDigital": null,
        "gpsAddressDetails": null
      },
      {
        "type": "Residence",
        "community": "COMMUNITY",
        "town": "TOWN NAME",
        "countryName": "COUNTRY NAME",
        "districtName": "DISTRICT NAME",
        "region": "REGION",
        "postalCode": "POSTAL CODE",
        "addressDigital": "GL-000-0000",
        "gpsAddressDetails": {
          "gpsName": "GL-000-0000",
          "region": "REGION",
          "district": "DISTRICT NAME",
          "area": "AREA",
          "street": "STREET NAME",
          "longitude": "-.000000000000000",
          "latitude": "0.000000000000000"
        }
      }
    ],
    "contact": {
      "email": "",
      "phoneNumbers": [
        {
          "type": "Mobile",
          "phoneNumber": "0000000000",
          "network": "MTN"
        }
      ]
    },
    "occupations": [
      {
        "name": "Unemployed"
      }
    ],
    "biometricFeed": [
      {
        "type": "face",
        "photo": "http://media-server/media/selfie/e97e0000-f78f-0000-9724-1e9dafcc0000.png"
      }
    ],
    "binaries": []
  },
  "error": null,
  "metadata": {
    "key": "value"
  }
}

Webhook errors

  "error": {
     "type": "govCheckError",
    "code": "ghanaianVerifyCardFacematch.notFound",
    "message": "No results were found in the Ghanaian Verify Card Facematch database"
  }
  "error": {
    "type": "govCheckError",
    "code": "ghanaianVerifyCardFacematch.notValidParams",
    "message": "The data passed appears to be invalid"
  }
  "error": {
    "type": "govCheckError",
    "code": "ghanaianVerifyCardFacematch.serviceUnavailable",
    "message": "The Verify Card Facematch service is unavailable"
  }
  "error": {
    "type": "govCheckError",
    "code": "system.internalError",
    "message": "Internal error has occurred"
  }
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!