LocateOne APIs

Confirm address

Last updated December 18, 2023

This API allows clients to verify if an address has been visited by a Field Executive and provides details of the visit.

POSThttps://api.getos1.com/locateone/v1/confirm

Headers

x-api-keystringrequired

This key is used for validation and quota management.

Content-typestringrequired

application/json

Body

bodyobjectoptional

addressstringrequired

Example: Yogi complex g wing room no 103 1st floor

citystringrequired

Example: Gurugram

phone_numberstringrequired

Example: 9660476235

pincodestringrequired

Example: 673593

statestringrequired

Example: Kerala

has_consentbooleanrequired

Example: true

consent_textstringrequired

Example: Consent from customer is required

Request example

curl --request POST \
     --url https://api.getos1.com/locateone/v1/confirm \
     --header 'accept: application/json' \
     --header 'content-type: string' \
     --header 'x-api-key: string' \
     --data '{
     "address": "Yogi complex g wing room no 103 1st floor",
     "city": "Gurugram",
     "phone_number": "9660476235",
     "pincode": "673593",
     "state": "Kerala",
     "has_consent": true,
     "consent_text": "Consent from customer is required"
     }'

Responses

200400401403500

200Successful response

dataobjectoptional

400Bad request

messagestringoptional

Example: Invalid request parameters.

401Unauthorized

messagestringoptional

Example: Unauthorized access. Invalid API key.

403Forbidden

messagestringoptional

Example: Forbidden. You do not have permissions to access this resource.

500Internal server error

messagestringoptional

Example: Internal server error. Please try again later.

Response samples

// Successful response
{
  "data": {}
}