🆔Customer ID Verification - HANIS

Plug into the Home Affairs National Identification System (HANIS) to retrieve and verify information on a Customer.

Please note that we will perform the Verification on the ID Number that was provided in the POST Create New Customer endpoint.

Explicit consent is required from the Customer to perform the ID verification call . As such the"popi" field in Create New Customer is required to be set as "true" for the successful completion of the api call.

Customer ID Verification

GET {{baseUrl}}/customers/:customer_id/verify-id-number-hanis

Extract a Customer's Identity details from the DHA database.

Path Parameters

Name	Type	Description
customer_id*	String	This is UUID for a specific customer that gets generated and returned in the POST Create New Customer response.

503: Service Unavailable Technical Error

```json
[
    {
        "code": "service_unavailable",
        "message": "Technical Error - the HANIS ID Verification Service is currently unavailable."
    }
]
```

422: Unprocessable Entity POPI Consent Required

```json
[
   {
    "errors": {
        "code": "popi_consent",
        "message": "You need to collect POPI consent for this Customer before trying to process an ID Verification. Please update the Customer details."
    }
   }
]
```

500: Internal Server Error Generic Error

```json
[
 {
   "errors": {
        "code": "error_verifying_identity”
        "message": " Please contact [e-mail]. The HANIS ID Verification Service is currently unavailable."
    }
 }
]
```

504: Gateway Timeout Cache Service Timeout

```json
[
 {
   "errors": {
        "code": "time_out",
        "message": "Cache Service Timeout - the HANIS ID Verification Service is currently unavailable."
    }
 }
]
```

503: Service Unavailable Could Not Reach HANIS

```json
[
 }
   {
   "errors": {
        "code": "service_unavailable",
        "message": "Could not reach HANIS - the HANIS ID Verification Service is currently unavailable."
    }
 }
]
```

503: Service Unavailable HANIS Unavailable

```json
[
     {
        "errors": {
        "code": "service_unavailable",
        "message": "DHA is currently down - the HANIS ID Verification Service is currently unavailable."
       }
     }
]
```

404: Not Found ID Number Not Found

```json
[
     {
        "errors": {
        "code": "id_number",
        "message": "SA ID Number not found. – Please ensure the ID number captured under the customer is correct."
         }
     }
]
```

404: Not Found No HANIS Details

```json
[
        {
        "errors": {
        "code": "id_number ",
        "message": "No HANIS details found for ID Number. – Please ensure the ID number captured under the customer is correct."
            }
        }
]
```

422: Unprocessable Entity Invalid ID Number

```json
[
     {
        "errors": {
        "code": "id_number",
        "message": "Invalid SA ID Number – Please ensure the ID number captured under the customer is correct."
       }
   }
]
```

503: Service Unavailable Service Provider Technical Error

```json
[
    {
        "code": "service_unavailable",
        "message": "Service Provider Technical Error - the HANIS ID Verification Service is currently unavailable."
    }
]
```

200: OK Successful ID Verification

```json
{
    "data": {
        "id": "d56c6eb9-0caf-4c36-ae3d-6be8841a10d4",
        "idNumber": "{{idNumber}}",
        "firstNames": "{{firstName}}",
        "surname": "{{lastName}}",
        "gender": "Female",
        "dateOfBirth": "1992-08-01T00:00:00",
        "status": "Active",
        "datePerformed": "2024-03-01T14:46:06.4871561+02:00",
        "birthPlaceCountryCode": "",
        "deadIndicator": false,
        "dateOfDeath": "",
        "maritalStatus": "",
        "dateOfMarriage": "",
        "idIssueDate": "20160831",
        "idSequenceNumber": "1",
        "onHANIS": true,
        "onNPR": true,
        "smartCardIssued": true,
        "idNumberBlocked": false,
        "photo": "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDABA.....",
        "dataSource": "DHA SAFPS",
        "hasPhoto": true
    }
}
```

Photo

At present we return the photo that HANIS has on record for the Customer in a Base64 string. This will need to be converted into an image file by the client.