LocateOne APIs

Correlate Address

Last updated December 18, 2023

This API allows clients to verify the correlation between an address and a corresponding mobile number.

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

Headers

x-api-keystringrequired

This key is used for authentication and billing.

Content-typestringrequired

application/json

Body

bodyobjectoptional

addressstringrequired

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

citystringoptional

Example: Kerala

phone_numberstringrequired

Example: 9660482753

pincodestringoptional

Example: 673593

statestringoptional

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/correlate \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: string' \
     --data '{
     "address": "Yogi complex g wing room no 103 1st floor",
     "phone_number": "9660482753",
     "has_consent": true,
     "consent_text": "Consent from customer is required"
     }'

Responses

200400500

200Successful response

dataobjectoptional

add_foundbooleanoptional

If the address has been independently found in the records.

Example: true

ph_foundbooleanoptional

If the phone number has been independently found in the records.

Example: false

add_ph_foundbooleanoptional

If the combination of address and phone number is found in the records.

Example: true

errornulloptional

messagestringoptional

Example: success

request_idstringoptional

Example: relatedness|aef66d7a-b09e-472f-b2b2-aa8e9ad3971e

status_codeintegeroptional

Example: 200

400Bad request

datanulloptional

errorobjectoptional

messagestringoptional

typestringoptional

messagestringoptional

request_idstringoptional

Example: relatedness|aef66d7a-b09e-472f-b2b2-aa8e9ad3971e

status_codeintegeroptional

Example: 500

500Server error

datanulloptional

errorobjectoptional

messagestringoptional

typestringoptional

messagestringoptional

request_idstringoptional

Example: relatedness|aef66d7a-b09e-472f-b2b2-aa8e9ad3971e

status_codeintegeroptional

Example: 500

Response samples

// Successful response
{
  "data": {
    "add_found": true,
    "ph_found": false,
    "add_ph_found": true
  },
  "error": "",
  "message": "success",
  "request_id": "relatedness|aef66d7a-b09e-472f-b2b2-aa8e9ad3971e",
  "status_code": 200
}