Verify South African Phone Number

SA Phone Number Verification

POST {{baseurl}}/v2/api/identity/za/phone

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
phoneNumber*	String	Users phone Number
phoneCountryCode*	String	Users phone number country code
isSubjectConsent*	Boolean	Indicate subject has given consent. Must be true

SA Phone Number Verification

SA Phone Number is used to verify that a provided South African number exists in the database as well as provide any associating information.

SA Phone Number Verification Sample Request

{
    "phoneNumber": "821112110",
    "phoneCountryCode": "+27",
    "isSubjectConsent": true
}

Found Response

{
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
        "id": "645bca00d80de606cd7e5acf",
        "parentId": null,
        "status": "found",
        "reason": null,
        "dataValidation": false,
        "selfieValidation": false,
        "phoneCountryCode": "27",
        "mobile": "[phone]",
        "phoneNumber": "821112110",
        "phoneTypeCode": "2",
        "phoneTypeDescription": "MOBILE",
        "phoneCity": "Countrywide",
        "phoneState": null,
        "phoneZip": null,
        "phoneCounty": null,
        "phoneCountry": "South Africa",
        "phoneCountryCodeISO2": "ZA",
        "phoneCountryCodeISO3": "ZAF",
        "carrier": "Vodacom SA",
        "isPhoneBlocked": false,
        "phoneBlockCode": "0",
        "phoneBlockDescription": "Not blocked",
        "phoneRiskLevel": "medium-low",
        "phoneRiskScore": "300",
        "phoneRiskRecommendation": null,
        "isBlacklistedCountryCode": "NA",
        "isBlackListedPhoneNumber": "NA",
        "isBlackListedPhoneType": "NA",
        "isPhoneNumberValid": true,
        "phoneRiskOutcome": "Medium",
        "isConsent": true,
        "idNumber": "821112110",
        "businessId": "628b38f03ae28a14f52d4bf7",
        "type": "zaPhone",
        "allValidationPassed": true,
        "requestedAt": "2023-05-10T16:44:56.417Z",
        "requestedById": "628b38f13ae28a7b742d4bf9",
        "country": "ZA",
        "createdAt": "2023-05-10T16:44:56.822Z",
        "lastModifiedAt": "2023-05-10T16:44:56.822Z",
        "metadata": {},
        "requestedBy": {
            "firstName": "Onyeka",
            "lastName": "Ijeh",
            "middleName": "",
            "id": "628b38f13ae28a7b742d4bf9"
        }
    },
    "links": []
}

Error Response

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}