Corporate Customer Director - Address Verification

curl -X 'POST' \
  'https://waas-staging.embedly.ng/api/v1/corporate/customers/58d05345-7cfa-11f0-8d44-4af84d9ff6f1/directors/58d05345-7cfa-11f0-8d44-4af84d9ff6f1/address-verification' \
  -H 'accept: */*' \
  -H 'x-api-key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "street": "Professor Gabriel Olusanya St",
  "city": "Lekki",
  "state": "Lagos",
  "country": "Nigeria",
  "flatNumber": "12B",
  "buildingNumber": "8",
  "landmark": "Lekki Phase 1 Gate",
  "gender": "F",
  "image": "/9j/4AAQSkZJRgABAQ...",
  "imageContentType": "image/jpeg"
}'

{
  "data": {
    "message": "Address verification completed successfully",
    "referenceNumber": "ADDR_20260409112339_6c6ffb63",
    "result": "Success"
  },
  "status": 200,
  "message": ""
}

{
  "data": {
    "message": "Address verification failed",
    "referenceNumber": "ADDR_20260409110211_12b106fa",
    "error": "Address verification could not be completed"
  },
  "status": 400,
  "message": ""
}

POST

corporate

customers

{customerId}

directors

{directorId}

address-verification

curl -X 'POST' \
  'https://waas-staging.embedly.ng/api/v1/corporate/customers/58d05345-7cfa-11f0-8d44-4af84d9ff6f1/directors/58d05345-7cfa-11f0-8d44-4af84d9ff6f1/address-verification' \
  -H 'accept: */*' \
  -H 'x-api-key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "street": "Professor Gabriel Olusanya St",
  "city": "Lekki",
  "state": "Lagos",
  "country": "Nigeria",
  "flatNumber": "12B",
  "buildingNumber": "8",
  "landmark": "Lekki Phase 1 Gate",
  "gender": "F",
  "image": "/9j/4AAQSkZJRgABAQ...",
  "imageContentType": "image/jpeg"
}'

{
  "data": {
    "message": "Address verification completed successfully",
    "referenceNumber": "ADDR_20260409112339_6c6ffb63",
    "result": "Success"
  },
  "status": 200,
  "message": ""
}

{
  "data": {
    "message": "Address verification failed",
    "referenceNumber": "ADDR_20260409110211_12b106fa",
    "error": "Address verification could not be completed"
  },
  "status": 400,
  "message": ""
}

Request Parameters

Send the request body as application/json. application/json-patch+json is also accepted. If your organisation has IP whitelisting enabled, the request must come from a whitelisted IP.

string

required

The unique identifier of a corporate customer. It must belong to the organisation that owns the API key and be a corporate customer, otherwise the request fails with a 400 or 404. Example: 58d05345-7cfa-11f0-8d44-4af84d9ff6f1

string

required

The unique identifier of a director of that corporate customer. A director of a different customer returns 404 “Director not found for this corporate customer”. Example: 58d05345-7cfa-11f0-8d44-4af84d9ff6f1

string

required

Street name. Maximum 250 characters. Example: Professor Gabriel Olusanya St

string

required

City or town. Maximum 100 characters. Example: Lekki

string

required

State. Maximum 100 characters. Example: Lagos

string

required

Country. Maximum 100 characters. Example: Nigeria

string

Flat or apartment number. Maximum 100 characters. Example: 12B

string

House or building number. Maximum 100 characters. Example: 8

string

A nearby landmark to help the field officer find the address. Maximum 500 characters. Example: Lekki Phase 1 Gate

string

The director’s gender: M or F. The director record has no gender, so this is the only place it comes from. Defaults to M if omitted. Example: F

string

A supporting document, such as a utility bill or a photo of the building, as raw base64 without the data:...;base64, prefix. Keep the file at 5 MB or less (maximum 30,000,000 characters). Example: /9j/4AAQSkZJRgABAQ...

string

MIME type of the file: image/jpeg, image/png or application/pdf. Required if image is sent. Maximum 100 characters. Example: image/jpeg

curl -X 'POST' \
  'https://waas-staging.embedly.ng/api/v1/corporate/customers/58d05345-7cfa-11f0-8d44-4af84d9ff6f1/directors/58d05345-7cfa-11f0-8d44-4af84d9ff6f1/address-verification' \
  -H 'accept: */*' \
  -H 'x-api-key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "street": "Professor Gabriel Olusanya St",
  "city": "Lekki",
  "state": "Lagos",
  "country": "Nigeria",
  "flatNumber": "12B",
  "buildingNumber": "8",
  "landmark": "Lekki Phase 1 Gate",
  "gender": "F",
  "image": "/9j/4AAQSkZJRgABAQ...",
  "imageContentType": "image/jpeg"
}'

{
  "data": {
    "message": "Address verification completed successfully",
    "referenceNumber": "ADDR_20260409112339_6c6ffb63",
    "result": "Success"
  },
  "status": 200,
  "message": ""
}

{
  "data": {
    "message": "Address verification failed",
    "referenceNumber": "ADDR_20260409110211_12b106fa",
    "error": "Address verification could not be completed"
  },
  "status": 400,
  "message": ""
}