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.
[
{
"code": "service_unavailable",
"message": "Technical Error - the HANIS ID Verification Service is currently unavailable."
}
]
```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."
}
}
]
```
```json
[
{
"errors": {
"code": "error_verifying_identity”
"message": " Please contact support@finch-technologies.com. The HANIS ID Verification Service is currently unavailable."
}
}
]
```
```json
[
{
"errors": {
"code": "time_out",
"message": "Cache Service Timeout - the HANIS ID Verification Service is currently unavailable."
}
}
]
```
```json
[
}
{
"errors": {
"code": "service_unavailable",
"message": "Could not reach HANIS - the HANIS ID Verification Service is currently unavailable."
}
}
]
```
```json
[
{
"errors": {
"code": "service_unavailable",
"message": "DHA is currently down - the HANIS ID Verification Service is currently unavailable."
}
}
]
```
```json
[
{
"errors": {
"code": "id_number",
"message": "SA ID Number not found. – Please ensure the ID number captured under the customer is correct."
}
}
]
```
```json
[
{
"errors": {
"code": "id_number ",
"message": "No HANIS details found for ID Number. – Please ensure the ID number captured under the customer is correct."
}
}
]
```
```json
[
{
"errors": {
"code": "id_number",
"message": "Invalid SA ID Number – Please ensure the ID number captured under the customer is correct."
}
}
]
```
```json
[
{
"code": "service_unavailable",
"message": "Service Provider Technical Error - the HANIS ID Verification Service is currently unavailable."
}
]
```
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.
Last updated
Was this helpful?
This is UUID for a specific customer that gets generated and returned in the response.