Address

Verify address.

post

This endpoint verifies an address using the provided address details. Use this endpoint to validate shipping addresses before creating shipments. A correct address is important for successful shipment booking and smooth delivery.

Important:

• country, state, and zip_code are critical for accurate verification.

• You can use the same value in address and address_in_detail.

• Use this endpoint before shipment creation to reduce failed shipment requests due to invalid addresses.

Authorizations

AuthorizationstringRequired

Use your base64-encoded public_key:private_key value.

Header parameters

X-Shipment-ModestringOptionalExample: SFN

Body

first_namestringRequired

First name.

Example: Friday

last_namestringRequired

Last name.

Example: Johnny

emailstringRequired

Email address.

Example: [e-mail]

phonestringRequired

Phone number.

Example: 09012345678

alternate_phonestringOptional

nullable Alternate phone number.

Example: 09012345687

countrystringRequired

Destination country code. This is critical for verification.

Example: GB

statestringRequired

Destination state/region code. This is critical for verification.

Example: ENG

citystringRequired

Destination city.

Example: London

addressstringRequired

Main address line.

Example: 221B Baker Street, Marylebone, London NW1 6XE, UK

address_in_detailstringRequired

Detailed address. You can use the same value as address.

Example: 221B Baker Street, Marylebone, London NW1 6XE, UK

address_landmarkstringOptional

nullable Nearby landmark to improve address matching.

Example: 221B Baker Street, Marylebone, London NW1 6XE

zip_codestringRequired

Postal/ZIP code. This is critical for verification.

Example: NW1 6XE

typestringRequired

The address type.

Example: receiver

longitudenumericOptional

sometimes Longitude value.

Example: -4.0109224

latitudenumericOptional

sometimes Latitude value.

Example: 4.7075493

street_numberstringOptional

sometimes Street number. Example:

Example: architecto

street_namestringOptional

sometimes Street name. Example:

Example: architecto

google_addressbooleanOptional

sometimes Whether this address originated from Google Address lookup.

Example: true

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Address verification completed successfully

500Error

application/json

post/api/v1/address/verify

POST /api/v1/address/verify HTTP/1.1
Host: api-sandbox.africaniestest.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 542

{
  "first_name": "Friday",
  "last_name": "Johnny",
  "email": "[e-mail]",
  "phone": "09012345678",
  "alternate_phone": "09012345687",
  "country": "GB",
  "state": "ENG",
  "city": "London",
  "address": "221B Baker Street, Marylebone, London NW1 6XE, UK",
  "address_in_detail": "221B Baker Street, Marylebone, London NW1 6XE, UK",
  "address_landmark": "221B Baker Street, Marylebone, London NW1 6XE",
  "zip_code": "NW1 6XE",
  "type": "receiver",
  "longitude": "-4.0109224",
  "latitude": "4.7075493",
  "street_number": "architecto",
  "street_name": "architecto",
  "google_address": true
}

{
  "success": true,
  "status_code": 200,
  "message": "Address verification completed successfully",
  "data": {
    "address": [
      {
        "countryCode": "GB",
        "postalCode": "NW16",
        "cityName": "LONDON",
        "serviceArea": {
          "code": "LHR",
          "description": "LONDON-HEATHROW-UNITED KINGDOM",
          "GMTOffset": "+00:00"
        }
      }
    ]
  }
}