{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "Reverse Phone Append",
"description": "Experian Reverse Phone Append API allows you to validate phone data and returns different types of phone information. This API can also link phone numbers with the person's name and postal address information, in real time."
},
"host": "api.experianmarketingservices.com",
"basePath": "/",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"AuthTokenHeader": []
},
{
"AuthTokenQueryParam": []
}
],
"paths": {
"/query/PhoneValidatePlus/1.0/": {
"post": {
"tags": ["Endpoints"],
"description": "Asynchronous - posts a phone number to the service to be validated. Make a GET /result request to retrieve the results.",
"summary": "Async - Query",
"operationId": "Async - Query",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "The body of the request.",
"schema": {
"$ref": "#/definitions/QueryRequestModel"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": "Content type to be returned.",
"default": "application/json"
}
],
"responses": {
"204": {
"description": "No content",
"headers": {
"Content-Location": {
"type": "string",
"description": "Location of the validation result"
}
}
},
"400": {
"description": "Request failed due to malformed syntax. Check the response header for more information"
},
"401": {
"description": "Provided token is incorrect"
},
"403": {
"description": "Request is not authorized to use the service"
},
"500": {
"description": "We have encountered an unexpected server error"
},
"503": {
"description": "The server is currently unavailable"
}
}
}
},
"/result/PhoneValidatePlus/1.0/{id}": {
"get": {
"tags": ["Endpoints"],
"description": "Asynchronous - retrieves the results of a Reverse Phone Append POST /query request. The URL for this request is returned in the Content-Location response header when making the initial query.",
"summary": "Async - Result",
"operationId": "Async - Result",
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string",
"description": "Id for the results of a synchronous Reverse Phone Append request. The full URL for this request is returned in the Content-Type header of a synchronous POST request."
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/QueryResultResponseModel"
}
},
"400": {
"description": "Request failed due to malformed syntax. Check the response header for more information"
},
"401": {
"description": "Provided token is incorrect"
},
"403": {
"description": "Request is not authorized to use the service"
},
"500": {
"description": "We have encountered an unexpected server error"
},
"503": {
"description": "The server is currently unavailable"
}
}
}
},
"/sync/queryresult/PhoneValidatePlus/1.0/": {
"post": {
"tags": ["Endpoints"],
"description": "Synchronous - posts a phone number to the service to be validated and, once complete, returns the results of the validation.",
"summary": "Sync - QueryResult",
"operationId": "Sync - QueryResult",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/QueryRequestModel"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": "Content type to be returned.",
"default": "application/json"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/QueryResultResponseModel"
}
},
"400": {
"description": "Request failed due to malformed syntax. Check the response header for more information"
},
"401": {
"description": "Provided token is incorrect"
},
"403": {
"description": "Request is not authorized to use the service"
},
"500": {
"description": "We have encountered an unexpected server error"
},
"503": {
"description": "The server is currently unavailable"
}
}
}
}
},
"securityDefinitions": {
"AuthTokenHeader": {
"type": "apiKey",
"in": "header",
"name": "auth-token",
"description": "Token used to authenticate your requests - sent in header."
},
"AuthTokenQueryParam": {
"type": "apiKey",
"in": "query",
"name": "auth-token",
"description": "Token used to authenticate your requests - sent as query parameter."
}
},
"definitions": {
"QueryRequestModel": {
"title": "QueryRequestModel",
"type": "object",
"properties": {
"Number": {
"description": "The calling party number is the phone number of the person who originates the call. There are two options of formatting
1. With calling country code (e.g. +15026576033)
2. Without calling country code (e.g. 5026576033) - DefaultCountryCode parameter is required for this option",
"type": "string",
"example": 15026576033
},
"DefaultCountryCode": {
"description": "The calling country code for the phone number in the Number parameter.",
"type": "string",
"example": "+1"
}
},
"required": [
"Number"
]
},
"QueryResultResponseModel": {
"title": "ResultResponseModel",
"type": "object",
"properties": {
"Number": {
"description": "Submitted phone number.",
"type": "string",
"example": 8139960713
},
"AccountType": {
"description": "The type of account.",
"type": "string",
"enum": [
"Business",
"Consumer",
"NoName"
],
"example": "Mobile"
},
"Name": {
"description": "Returned business or consumer name.",
"type": "string",
"example": "Arbea J Bond"
},
"FirstName": {
"description": "Returned business or consumer first name.",
"type": "string",
"example": "Arbea"
},
"MiddleInitial": {
"description": "Returned business or consumer middle initial.",
"type": "string",
"example": "J"
},
"LastName": {
"description": "Returned business or consumer last name.",
"type": "string",
"example": "Bond"
},
"PhoneType": {
"description": "The type of phone number.",
"type": "string",
"enum": [
"Landline",
"Mobile",
"Other",
"Provided number is invalid"
],
"example": "Mobile"
},
"Address": {
"type": "object",
"properties": {
"Certainty": {
"type": "string",
"description": "The confidence of the address.",
"enum": [
"FullAddress",
"PartialAddress",
"NoAddress"
],
"example": "FullAddress"
},
"Number1": {
"type": "string",
"description": "House or Building number.",
"example": "4049"
},
"Street1": {
"type": "string",
"description": "Street name and type.",
"example" : "Mitchell Road"
},
"Locality": {
"type": "string",
"description": "Locality or City.",
"example": "Land O Lakes"
},
"Province": {
"type": "string",
"description": "Province/State.",
"example": "FL"
},
"Postcode1": {
"type": "string",
"description": "Postal Code.",
"example": "34638-3524"
}
}
},
"Country": {
"description": "The country.",
"type": "string",
"enum":[
"USA",
"Canada"
],
"example": "USA"
},
"Certainty": {
"description": "Indicates the confidence of the phone number.",
"type": "string",
"example": "Verified"
}
}
}
}
}