> For the complete documentation index, see [llms.txt](https://docs.africanies.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.africanies.com/address.md).

# Address

## Verify address.

> 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.

```json
{"openapi":"3.0.3","info":{"title":"AfricanIES - Sandbox API Documentation","version":"1.0.0"},"tags":[{"name":"Address","description":""}],"servers":[{"url":"https://api-sandbox.africaniestest.com"}],"security":[{"default":[]}],"components":{"securitySchemes":{"default":{"type":"apiKey","name":"Authorization","in":"header","description":"Use your base64-encoded public_key:private_key value."}}},"paths":{"/api/v1/address/verify":{"post":{"summary":"Verify address.","operationId":"verifyAddress","description":"This endpoint verifies an address using the provided address details.\nUse this endpoint to validate shipping addresses before creating shipments.\nA correct address is important for successful shipment booking and smooth delivery.\n\nImportant:\n- `country`, `state`, and `zip_code` are critical for accurate verification.\n- You can use the same value in `address` and `address_in_detail`.\n- Use this endpoint before shipment creation to reduce failed shipment requests due to invalid addresses.","parameters":[{"in":"header","name":"X-Shipment-Mode","description":"","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status_code":{"type":"integer"},"message":{"type":"string"},"data":{"type":"object","properties":{"address":{"type":"array","items":{"type":"object","properties":{"countryCode":{"type":"string"},"postalCode":{"type":"string"},"cityName":{"type":"string"},"serviceArea":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"GMTOffset":{"type":"string"}}}}}}}}}}}}},"500":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"status_code":{"type":"integer"},"message":{"type":"string"},"data":{"type":"array"}}}}}}},"tags":["Address"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string","description":"First name."},"last_name":{"type":"string","description":"Last name."},"email":{"type":"string","description":"Email address."},"phone":{"type":"string","description":"Phone number."},"alternate_phone":{"type":"string","description":"nullable Alternate phone number."},"country":{"type":"string","description":"Destination country code. This is critical for verification."},"state":{"type":"string","description":"Destination state/region code. This is critical for verification."},"city":{"type":"string","description":"Destination city."},"address":{"type":"string","description":"Main address line."},"address_in_detail":{"type":"string","description":"Detailed address. You can use the same value as `address`."},"address_landmark":{"type":"string","description":"nullable Nearby landmark to improve address matching."},"zip_code":{"type":"string","description":"Postal/ZIP code. This is critical for verification."},"type":{"type":"string","description":"The address type."},"longitude":{"type":"numeric","description":"sometimes Longitude value."},"latitude":{"type":"numeric","description":"sometimes Latitude value."},"street_number":{"type":"string","description":"sometimes Street number. Example:"},"street_name":{"type":"string","description":"sometimes Street name. Example:"},"google_address":{"type":"boolean","description":"sometimes Whether this address originated from Google Address lookup."}},"required":["first_name","last_name","email","phone","country","state","city","address","address_in_detail","zip_code","type"]}}}}}}}}
```