Skip to main content
GET
/
address-from-short
Get full address from short address code
curl --request GET \
  --url https://staging.yasmina.ai/api/v1/property/address-from-short \
  --header 'Authorization: Bearer <token>'
{
  "street_name": "King Abdulaziz Road",
  "building_number": "345",
  "district_name": "Al Olaya",
  "city_name": "Riyadh",
  "additional_number": "1234",
  "zip_code": "12233",
  "unit_number": "12B"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
short_address
string
required

Short address code provided by Saudi Post or similar systems

Response

Successfully retrieved address information

​
street_name
string
Example:

"King Abdulaziz Road"

​
building_number
string
Example:

"345"

​
district_name
string
Example:

"Al Olaya"

​
city_name
string
Example:

"Riyadh"

​
additional_number
string
Example:

"1234"

​
zip_code
string
Example:

"12233"

​
unit_number
string
Example:

"12B"