Skip to main content
POST
/
v1
/
physicalAddress
curl -X POST https://api.vouchmark.com/v1/physicalAddress \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "companyId": "cmp_aBcD...",
    "business_name": "Tekcify Technologies Ltd",
    "business_mobile": "08030000000",
    "first_name": "Jane",
    "last_name": "Doe",
    "mobile": "08031111111",
    "street": "14 Marina Road",
    "landmark": "Opposite the City Mall",
    "lga": "Lagos Island",
    "city": "Lagos",
    "state": "Lagos"
  }'

{
  "entity": {
    "status": "pending",
    "reference_id": "addr_aBcD..."
  }
}
Submit a company’s business address for physical verification through the underlying KYC provider, then poll for the result. Submission returns a reference_id and an initial status; the status endpoint reports progress and, once complete, the captured address data. Both calls require an authenticated owner. The submit body is JSON.

​
Submit — POST /v1/physicalAddress

​
companyId
string
required
The company being verified.
​
business_name
string
required
​
business_mobile
string
required
​
first_name
string
required
​
last_name
string
required
​
mobile
string
required
​
street
string
required
​
landmark
string
required
​
lga
string
required
​
city
string
required
​
state
string
required
curl -X POST https://api.vouchmark.com/v1/physicalAddress \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "companyId": "cmp_aBcD...",
    "business_name": "Tekcify Technologies Ltd",
    "business_mobile": "08030000000",
    "first_name": "Jane",
    "last_name": "Doe",
    "mobile": "08031111111",
    "street": "14 Marina Road",
    "landmark": "Opposite the City Mall",
    "lga": "Lagos Island",
    "city": "Lagos",
    "state": "Lagos"
  }'

{
  "entity": {
    "status": "pending",
    "reference_id": "addr_aBcD..."
  }
}

​
Check status — GET /v1/physicalAddress

Poll with either the reference_id from submission or the companyId. At least one is required.
​
reference_id
string
The reference returned at submission.
​
companyId
string
The company whose latest address verification you want. Resolves to the stored reference.
cURL
curl "https://api.vouchmark.com/v1/physicalAddress?companyId=cmp_aBcD..." \
  -H "Authorization: Bearer $TOKEN"
Until the visit completes, data is absent. Once complete, data carries the captured applicant, location, and photos.
Status — completed
{
  "entity": {
    "status": "completed",
    "reference_id": "addr_aBcD...",
    "data": {
      "applicant": {
        "first_name": "Jane",
        "last_name": "Doe",
        "phone": "08031111111"
      },
      "location": "14 Marina Road, Lagos",
      "photos": ["https://..."],
      "city": "Lagos",
      "street": "14 Marina Road",
      "lga": "Lagos Island",
      "state": "Lagos",
      "country": "Nigeria"
    }
  }
}

​
Errors

StatusBodyWhen
401{ "message": "Unauthorized" }No authenticated user.
400{ "message": "companyId is required" }Submit without companyId.
400{ "message": "Missing required fields: ..." }One or more required submit fields are empty.
400{ "message": "Either reference_id or companyId is required" }Status check with neither parameter.
404{ "message": "Company not found or you don't have access to it" }The company is missing or not yours.
404{ "message": "No address verification found for this company" }Status check by companyId with no prior submission.
402{ "message": "Monthly investigation budget limit exceeded", "code": "...", "details": {...} }The monthly budget cap was reached.
Submission is rate limited to 5 attempts per 24 hours per caller.