Get Phone Number Info

Description

If available, this API will return all carrier data associated with the number passed in the request.
If no carrier data is available it will return an error.

Service Name	Get Phone Number Info
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/phone/actions/verify/{mobile}
Production URL	https://integration.himarley.io/api/phone/actions/verify/{mobile}
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Path Breakdown
• API Response
  • Response Payload Example
  • Response Fields Breakdown
• Common Errors to Handle

API Request

Flow

1. Send API request with the path parameter of the Mobile number.
2. Hi Marley receives the request and validates with Carrier.
3. Hi Marley responds with the Mobile number object data from our SMS provider.

Request Example

https://integration.uat.marley.ai/api/phone/actions/verify/8214449999

 

Request Path Breakdown

Property	Values	Description	Type	Required	Example	Validation
mobile		The mobile number associated to the user.	string	true	8214449999	The phone number is registered with a carrier.

 

API Response 

Response Payload Example

{
    "carrier": "Verizon Wireless",
    "type": "mobile",
    "mobileCountryCode": "311",
    "mobileNetworkCode": "489",
    "country": "US",
    "formattedNumber": "[phone]",
    "user": "king schultz",
    "userType": "consumer"
}

 

Response Fields Breakdown

Element	Description	Type	Required	Example
carrier	The network carrier associated to the mobile number entered.	string	true	"carrier": "Verizon Wireless"
type	The device type associated to the mobile number entered.	string	true	"type": "mobile"
mobileCountrycode	Description	int	true	"mobileCountryCode": "311"
mobileNetworkCode	Description	int	true	"mobileNetworkCode": "489"
country	The country associated with the mobile number entered.	string	true	"country": "US"
formattedNumber	The mobile number entered as formatted.	int	true	"formattedNumber": "[phone]"
user	The user currently assigned to the mobile number according to carrier records.	string	true	"user": "king schultz"
userType	Return value from carrier.	string	true	"userType": "consumer"

Common Errors to Handle

• PhoneNumberNotFound[404]- More Details