Skip to main content

Search Bulk Address

POST /api/v1/searches/public/bulk/address

Description​

Search for bulk addresses.

Path Parameters​

NameTypeDescription
NoneNo parameters

Request Body​

  • Content Type: application/json
{
  "address": "string",
  "isAddressOnly": true,
  "country": {
    "name": "string",
    "code": "string",
    "currency": "string"
  },
  "state": {
    "name": "string",
    "code": "string"
  },
  "lga": {
    "name": "string",
    "code": "string"
  }
}

Response Code: 201 - Created​

Description

Address search created successfully.

Response Fields

No response fields.

Example​

{
  "status": true,
  "statusCode": 201,
  "message": "Address search created successfully",
  "data": {},
  "errors": []
}

Body​

{
  "address": "123 Main St",
  "isAddressOnly": true,
  "country": {
    "name": "CountryName",
    "code": "CNY",
    "currency": "CurrencyName"
  },
  "state": {
    "name": "StateName",
    "code": "ST"
  },
  "lga": {
    "name": "LgaName",
    "code": "LG"
  }
}

🔑 Authentication bearer​

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/searches/public/bulk/address \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!