SignCare

Geocoding Address

2 endpoints · Core API

What is Geocoding Address?

Reverse Geocoding API provides a seamless way to convert geographical coordinates into detailed physical addresses. By simply inputting latitude and longitude, this intuitive API returns a comprehensive address that includes the city, state, country, and zip code accurately mapped to the specified coordinates. Users can easily make a cURL request to retrieve the address, accompanied by a confidence score that reflects the accuracy of the geocoding result. This API serves as a reliable bridge between coordinate data and real-world locations, offering precise and efficient address retrieval.

What you can do

Accurate Address Conversion: Effortlessly transforms latitude and longitude coordinates into precise physical addresses.

Enhanced Data Insights: Provides detailed location data, including city, state, country, and zip code, for better context and decision-making.

Confidence Scoring: Offers a confidence score with each result, ensuring users understand the accuracy of the data.

Easy Integration: Simplifies implementation with straightforward cURL requests, making it user-friendly for developers.

POST

/api/v1/geocoding/latlong

#

Get Address details

docs.signcare.io/core/api/geolocation/geocoding-address/#post-api-v1-geocoding-latlong

Headers

  • X-API-KEY
    stringrequired
    Your secret API key for the environment you are calling (Stage and Live use different keys).
  • X-API-APP-ID
    stringrequired
    The App ID issued together with the key.
  • Content-Type
    stringrequired
    application/json

Body parameters

application/json
  • consent
    stringrequired
    Required. The end user's consent to this verification. Send `Y`.
    minLength 1default Y
  • consent_text
    stringrequired
    Required. The consent statement shown to the end user. Send the default text from the sample.
    minLength 1default I hear by declare my consent agreeme…
  • request_id
    stringoptional
    Optional. Your own id to correlate this call in your logs. A unique id is generated if you leave it out.
    nullable
  • address
    stringrequired
    Required. Free-text address to convert into coordinates (for example a street, city and PIN code). An empty value fails the request.
    nullabledefault Connaught Place, New Delhi, 110001
Sample request body
{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "address": "Connaught Place, New Delhi, 110001" }

Responses

200OK
  • success
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 200
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • data
    objectoptional
    Response model containing forward geocoding results.
    1 field
    • results
      array<object>optional
      Array of geocoding results matching the address query.
      nullable
      Each item: 3 fields
      • geometry
        objectoptional
        Geometry details containing the geographic location coordinates.
        1 field
        • location
          objectoptional
          Geographic coordinates with latitude and longitude values.
          2 fields
          • lat
            number (double)optional
            Latitude coordinate of the location.
          • lng
            number (double)optional
            Longitude coordinate of the location.
      • formatted_address
        stringoptional
        Human-readable formatted address string.
        nullable
      • googleMapUrl
        stringoptional
        Google Maps URL for the geocoded location.
        nullable
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • isBillable
    booleanoptional
    Whether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.
Example
{ "success": false, "statusCode": 200, "message": "XXXXX", "data": { "results": [ { "geometry": { "location": { "lat": 0, "lng": 0 } }, "formatted_address": "string", "googleMapUrl": "string" } ] }, "messages": [ "string" ], "request_id": "string", "isBillable": false }
400Bad Request
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 400
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }
401Unauthorized
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 401
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }
500Internal Server Error
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 500
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }
Code samplescurl · Node.js · Python
Stage: uat-ext.signcare.io
curl -X POST 'https://uat-ext.signcare.io/api/v1/geocoding/latlong' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "address": "Connaught Place, New Delhi, 110001" }'
POST

/api/v1/geocoding/address

#

Get Address details

docs.signcare.io/core/api/geolocation/geocoding-address/#post-api-v1-geocoding-address

Headers

  • X-API-KEY
    stringrequired
    Your secret API key for the environment you are calling (Stage and Live use different keys).
  • X-API-APP-ID
    stringrequired
    The App ID issued together with the key.
  • Content-Type
    stringrequired
    application/json

Body parameters

application/json
  • consent
    stringrequired
    Required. The end user's consent to this verification. Send `Y`.
    minLength 1default Y
  • consent_text
    stringrequired
    Required. The consent statement shown to the end user. Send the default text from the sample.
    minLength 1default I hear by declare my consent agreeme…
  • request_id
    stringoptional
    Optional. Your own id to correlate this call in your logs. A unique id is generated if you leave it out.
    nullable
  • latitude
    number (double)required
    Required. Latitude in decimal degrees, from -90 to 90 (for example 28.6315). Must be sent together with longitude; if either is missing the request fails. Values are used to six decimal places.
    nullablemin -90max 90default 28.6315
  • longitude
    number (double)required
    Required. Longitude in decimal degrees, from -180 to 180 (for example 77.2167). Must be sent together with latitude; if either is missing the request fails. Values are used to six decimal places.
    nullablemin -180max 180default 77.2167
Sample request body
{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "latitude": 28.6315, "longitude": 77.2167 }

Responses

200OK
  • success
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 200
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • data
    objectoptional
    Standardized location response with address, coordinates, and confidence score.
    11 fields
    • address
      stringoptional
      Full address string of the location.
      nullable
    • latitude
      stringoptional
      Latitude coordinate of the location.
      nullable
    • longitude
      stringoptional
      Longitude coordinate of the location.
      nullable
    • confidenceScore
      number (double)optional
      Confidence score indicating the accuracy of the geocoding result.
    • city
      stringoptional
      City name of the location.
      nullable
    • state
      stringoptional
      State name of the location.
      nullable
    • stateCode
      stringoptional
      State code abbreviation.
      nullable
    • country
      stringoptional
      Country name of the location.
      nullable
    • countryCode
      stringoptional
      Country code abbreviation (e.g., IN, US).
      nullable
    • zipcode
      stringoptional
      ZIP or postal code of the location.
      nullable
    • googleMapUrl
      stringoptional
      Google Maps URL for the location.
      nullable
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • isBillable
    booleanoptional
    Whether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.
Example
{ "success": false, "statusCode": 200, "message": "XXXXX", "data": { "address": "string", "latitude": "string", "longitude": "string", "confidenceScore": 0, "city": "string", "state": "string", "stateCode": "string", "country": "string", "countryCode": "string", "zipcode": "string", "googleMapUrl": "string" }, "messages": [ "string" ], "request_id": "string", "isBillable": false }
400Bad Request
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 400
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }
401Unauthorized
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 401
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }
500Internal Server Error
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 500
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }
Code samplescurl · Node.js · Python
Stage: uat-ext.signcare.io
curl -X POST 'https://uat-ext.signcare.io/api/v1/geocoding/address' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "consent": "Y", "consent_text": "I hear by declare my consent agreement for fetching my information via SignCare API", "latitude": 28.6315, "longitude": 77.2167 }'
All Geolocation & Address Services pages