Address

Verify address.

post

This endpoint verifies an address using the provided address details.

Header parameters

X-Shipment-ModestringOptionalExample: SFN

Body

application/json

first_namestringRequired

The first name.

Example: John

last_namestringRequired

The last name.

Example: Doe

emailstringRequired

The email address.

Example: [email protected]

phonestringRequired

The phone number.

Example: [phone]

alternate_phonestringOptional

nullable The alternate phone number.

Example: +0987654321

countrystringRequired

The country code or name.

Example: US

statestringRequired

The state.

Example: California

citystringRequired

The city.

Example: Los Angeles

addressstringRequired

The address.

Example: 123 Main Street

address_in_detailstringRequired

Detailed address.

Example: Apartment 4B, Building 123

address_landmarkstringOptional

nullable Address landmark.

Example: Near Central Mall

zip_codestringRequired

The zip code.

Example: 90210

typestringRequired

The address type.

Example: receiver

longitudenumericOptional

sometimes The longitude.

Example: -118.2437

latitudenumericOptional

sometimes The latitude.

Example: 34.0522

street_numberstringOptional

sometimes The street number.

Example: 123

street_namestringOptional

sometimes The street name.

Example: Main Street

google_addressbooleanOptional

sometimes Whether it's a Google address.

Example: true

Responses

200Success

application/json

successbooleanOptionalExample: true

status_codeintegerOptionalExample: 200

messagestringOptionalExample: Address verification completed successfully

500Error

application/json

post

/api/v1/address/verify

HTTPcURLJavaScriptPython

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

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone": "[phone]",
  "alternate_phone": "+0987654321",
  "country": "US",
  "state": "California",
  "city": "Los Angeles",
  "address": "123 Main Street",
  "address_in_detail": "Apartment 4B, Building 123",
  "address_landmark": "Near Central Mall",
  "zip_code": "90210",
  "type": "receiver",
  "longitude": "-118.2437",
  "latitude": "34.0522",
  "street_number": "123",
  "street_name": "Main Street",
  "google_address": true
}

{
  "success": true,
  "status_code": 200,
  "message": "Address verification completed successfully",
  "data": {
    "verified": true,
    "address": "123 Main Street, Los Angeles, CA 90210",
    "confidence": 0.95
  }
}