POST api/hlr/verification

Submit a mobile verification (asynchronous). Limit: 360 requests per minute.

Request Information

Header Description

Key	Value	Information
Authorization	Bearer access_token	The access_token is retrieved by the authentication method.

Body Parameters

sat.WebServices.Models.Hlr.VerificationRequest

Name	Description	Type	Additional information
Mobile	Phone number	string	Required
Pays	Country Code (ISO2, ISO3, Full ('FR', 'Fra', 'France')	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Mobile": "sample string 1",
  "Pays": "sample string 2"
}

application/xml, text/xml

Sample:

<VerificationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Mobile>sample string 1</Mobile>
  <Pays>sample string 2</Pays>
</VerificationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

sat.WebServices.Models.Hlr.VerificationResponse

Name	Description	Type	Additional information
Message	Message related to the return code	string	None.
Code	Return code	string	None.
CampagneId	Campaign identifier	string	None.
Mobile	Phone number in international format	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "Code": "sample string 2",
  "CampagneId": "sample string 3",
  "Mobile": "sample string 4"
}

application/xml, text/xml

Sample:

<VerificationResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Message>sample string 1</Message>
  <Code>sample string 2</Code>
  <CampagneId>sample string 3</CampagneId>
  <Mobile>sample string 4</Mobile>
</VerificationResponse>