Address By Phone

1.1. send pin code

Send pin code is a private API for specific customers to send pin code to client to make sure the national address is belonged to this customer.

Usage:

You must use an access token to make an authenticated call to our system. Access token are generated based on your subscription type. To get your access token please refer to “Your Subscriptions” section available on profile page.

Limits for calls to API

Our system doesn’t apply any limits on number of requests you can make for a particular API. But there are limits defined for total number of calls you can make per min and in one week. 

API Request 
Input Parameters

Requested URL

https://apina.address.gov.sa/NationalAddress/v3.1/AddressByPhoneWithPinCode/UPDS API/api/OTP/GetPinCode?StoreId=[StoreId]&MobileNo=[MobileNo]&api_key=[api_key]

Response

Default Fields Returned

The following fields are returned the send pin code request:

Sample Response
JSON

{  
	"ErrorCode": "OTP001",  
	"ErrorFriendlyMessage": "",  
	"Status": true,  
	"SystemErrorMessage": "",  
	"PinCode": "1045",  
	"SMSBody": " بإدخال الرمز تسمح بمشاركة عنوانك مع ارسل 1045 "رمز التحقق 
} 
 
Or  
 
{  
	"ErrorCode": "OTP005",  
	"ErrorFriendlyMessage": "Invalid Submitted Data",  
	"Status": false,  
	"SystemErrorMessage": "",  
	"PinCode": null,  
	"SMSBody": null  
}

1.2. Get NA by using pin code

Get NA by using pin code is a private API for specific customers to get national address by phone number after confirming the pin code which you send first.

Usage:

You must use an access token to make an authenticated call to our system. Access token are generated based on your subscription type. To get your access token please refer to “Your Subscriptions” section available on profile page.

Limits for calls to API

Our system doesn’t apply any limits on number of requests you can make for a particular API. But there are limits defined for total number of calls you can make per min and in one week. 

API Request 
Input Parameters

Requested URL

https://apina.address.gov.sa/NationalAddress/v3.1/AddressByPhoneWithPinCode/UPDS API/api/OTP/GetAddresses?StoreId=[StoreId]&MobileNo=[MobileNo]&PinCode=[PinCode] &api_key=[api_key]

Response

Default Fields Returned

By default, only the following fields are returned for a profile request:

Sample Response
JSON

{  
	"waselAddressDetails": [{  
		"City": "",  
		"CityName": "",  
		"District": "",  
		"DistrictArea": null,  
		"DistrictName": "",  
		"LocationX": "",  
		"LocationY": "",  
		"LocationZ": "",  
		"MobileNo": "",  
		"Street": "",  
		"Street_NameEn": "",  
		"StreetName": "",  
		"UnitNo": "",  
		"UnitTypeID": ""  
	}],  
	"genericResult":{  
		"ErrorCode": null,  
		"ErrorFriendlyMessage": null,  
		"Status": true, 
		"SystemErrorMessage": null,  
		"RequestId": -1    
		}  
} 
 
Or  
 
{  
	"waselAddressDetails": null,  
	"genericResult": {  
		"ErrorCode": "Add004",  
		"ErrorFriendlyMessage": 
		"Internal API Request Error",  
		"Status": true,  
		"SystemErrorMessage": "The transaction under which this method call was executing was asynchronously aborted.",  
		"RequestId": -1   
		}  
}

Common Errors

If there's an error with your API call, LinkedIn will return a HTTP status code along with a message detailing the error.

Error & Alert Notification codes