SATIK API · V1 BETA
Shared schemas
Reusable data structures used across the API. Expand a schema to inspect its fields and constraints.
AddressInput
{
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "string",
"minLength": 5,
"maxLength": 280
},
"phone": {
"type": "string"
},
"order_id": {
"type": "string",
"maxLength": 200
},
"order_value": {
"type": "number",
"minimum": 0,
"description": "Order value in rupees."
},
"payment_method": {
"enum": [
"COD",
"PREPAID",
"UPI"
]
},
"idempotency_key": {
"type": "string",
"maxLength": 200
}
}
}Verification
{
"type": "object",
"required": [
"id",
"verdict",
"recommended_action",
"flags",
"address",
"location",
"history",
"meta"
],
"properties": {
"id": {
"type": "string"
},
"order_id": {
"type": "string"
},
"verdict": {
"enum": [
"SHIP",
"REVIEW",
"VERIFY_FIRST"
]
},
"recommended_action": {
"enum": [
"SHIP_AS_IS",
"CONFIRM_PINCODE",
"REQUEST_UNIT_NUMBER",
"REQUEST_LANDMARK",
"REQUEST_FULL_ADDRESS",
"CONFIRM_CORRECTIONS",
"CALL_CUSTOMER",
"MANUAL_REVIEW"
]
},
"flags": {
"type": "array",
"items": {
"enum": [
"missing_unit",
"wrong_pincode_replaced",
"pincode_locality_mismatch",
"unconfirmed_locality",
"unconfirmed_building",
"landmark_only_routing",
"address_incomplete",
"suspicious_components",
"no_history",
"high_rto_area",
"phone_invalid",
"plus_code_fallback",
"inferred_components",
"spell_corrected",
"address_truncated"
]
}
},
"address": {
"type": "object",
"properties": {
"input": {
"type": "string"
},
"normalized": {
"type": "string"
},
"components": {
"$ref": "#/components/schemas/Components"
},
"corrections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"from": {
"type": "string"
},
"to": {
"type": "string"
},
"source": {
"type": "string"
}
}
}
}
}
},
"location": {
"type": "object",
"properties": {
"lat": {
"type": [
"number",
"null"
]
},
"lng": {
"type": [
"number",
"null"
]
},
"digipin": {
"type": [
"string",
"null"
]
},
"digipin8": {
"type": [
"string",
"null"
]
},
"resolution": {
"enum": [
"ROOFTOP_BUILDING",
"STREET_LEVEL",
"LOCALITY_LEVEL",
"UNKNOWN"
]
},
"place_id": {
"type": "string"
}
}
},
"history": {
"type": "object",
"properties": {
"digipin8_verifications": {
"type": "integer"
},
"digipin8_outcomes": {
"type": "integer"
},
"digipin8_rto_rate": {
"type": [
"number",
"null"
]
},
"unit_known": {
"type": "boolean"
},
"unit_outcomes": {
"type": "integer"
}
}
},
"meta": {
"type": "object",
"properties": {
"cache_hit": {
"type": "boolean"
},
"latency_ms": {
"type": "number"
},
"cost_paise": {
"type": "number"
},
"demo": {
"type": "boolean"
},
"idempotent_replay": {
"type": "boolean"
}
}
}
}
}Components
{
"type": "object",
"properties": {
"unit": {
"type": [
"string",
"null"
]
},
"street": {
"type": [
"string",
"null"
]
},
"landmark": {
"type": [
"string",
"null"
]
},
"locality": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"pincode": {
"type": [
"string",
"null"
]
}
}
}Error
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"code",
"message",
"doc_url",
"request_id"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"doc_url": {
"type": "string"
},
"request_id": {
"type": "string"
}
}
}
}
}