SATIK API · V1 BETA

Encode a location

POST

https://api.satik.in/v1/digipin/encode

Use a server-side Bearer API key. Authentication guide →

Sample request (cURL)

Set the Postman variable SATIK_TEST_KEY to a test key from your workspace.

curl --request POST 'https://api.satik.in/v1/digipin/encode' \
  --header 'Authorization: Bearer {{SATIK_TEST_KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "lat": 28.6224708,
  "lng": 77.2131656
}'

Converts sample coordinates into a DIGIPIN locally without calling Google. Coordinates must be within the supported India bounds. A location code alone does not verify an address.

In Postman, choose Import and paste this cURL command. These double-brace variables are resolved by Postman; for a terminal request, replace them with actual values. For local testing, replace https://api.satik.in/v1 with http://localhost:3001/api/v1, keeping the endpoint path.

Request schema

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "lat",
          "lng"
        ],
        "properties": {
          "lat": {
            "type": "number",
            "minimum": 2.5,
            "maximum": 38.5
          },
          "lng": {
            "type": "number",
            "minimum": 63.5,
            "maximum": 99.5
          }
        }
      }
    }
  }
}

Responses and errors

HTTP 200

{
  "description": "Success",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "digipin": {
            "type": "string"
          },
          "digipin8": {
            "type": "string"
          }
        }
      }
    }
  }
}

HTTP 400

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 401

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 403

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 409

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 422

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 429

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 500

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 502

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 503

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 504

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

View shared schemas →