Phone Available

This endpoint is used to determine if a cell phone number has already been associated with a client. A cell phone number can be associated to multiple clients, however this endpoint can be used to check to see if the cell phone number has already been associated to another client.

Response Schema

AttributeTypeDescription
statusCodeIntegerStandard HTTP response code. Status codes are outlined in the Errors section of this API reference.
messageStringA human-readable message providing more details about the status code. Messages are outlined in the Errors section of this API reference.
dataBooleanTrue indicates that the phone number has not been previously used.

False indicates that the phone number has been previously used.
errorsArray of StringsAn array of human-readable error messages, if available (null otherwise). Unique errors associated with this endpoint, if applicable, are shown in the example response in the right column with the corresponding HTTP status code.
Body Params
string
required

The cell phone number to be verified (e.g. 7805551029).

Response

Language
Credentials
OAuth2
Request
Choose an example:
application/json