Phone Contact Match API

Introduction

The Phone Contact Match API by Signzy is a powerful tool designed to verify and retrieve comprehensive information associated with provided phone numbers. The API by Signzy serves as a crucial tool in ensuring the accuracy, reliability, and legitimacy of phone number-related information. Its ability to provide comprehensive details assists in creating secure, trustworthy interactions and operational procedures across a spectrum of industries and application scenarios.

Use Case

This API by Signzy can be utilized in various industries and application scenarios to enhance the accuracy and reliability of phone number-related information. Here are some potential use cases for this API: 1. Identity Verification for Online Accounts: Online platforms can use this API to verify the authenticity of phone numbers during the account registration process. This helps in reducing the risk of fraudulent accounts and ensures that users provide accurate contact information. 2. Know Your Customer (KYC) Compliance: Financial institutions and businesses that need to comply with KYC regulations can use this API to verify the personal information associated with a phone number. It helps in confirming the identity of customers during onboarding processes. 3. Fraud Prevention and Detection: Businesses can use the API to check whether a phone number is associated with any fraudulent activity or has been reported as blocked. This helps in preventing fraudulent transactions and activities. Applications

API Details

Endpoints

curl --location 'https://api.signzy.app/api/v3/global/tele-contact-match' \
--header 'Authorization:<Auth-Toke>' \
--header 'Content-Type: application/json' \
--data '{
    "phoneNumber": "",
    "originatingIp": ""
}'

Request Body Parameters

Parameter	Data Type	Description	Required
phoneNumber	String	The phone number to be analyzed for digital footprint and risk signals. For best accuracy, provide the number in format with country code	Mandatory
originatingIp	String	The originating IP address of the end user request. Used for additional risk and contextual analysis.	Optional

{
    "phoneNumber": "",
    "originatingIp": ""
}

Response Body Parameters

{
  "result": {
    "referenceId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "externalId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": {
      "code": 300,
      "description": "Transaction successfully completed",
      "updatedOn": "YYYY-MM-DD"
    },
    "phoneType": {
      "code": "X",
      "description": "MOBILE"
    },
    "blocklisting": {
      "blocked": false,
      "blockCode": 0,
      "blockDescription": "Not blocked"
    },
    "numbering": {
      "cleansing": {
        "call": {
          "countryCode": "XX",
          "phoneNumber": "XXXXXXXXXX",
          "cleansedCode": 100,
          "minLength": 0,
          "maxLength": 0
        },
        "sms": {
          "countryCode": "XX",
          "phoneNumber": "XXXXXXXXXX",
          "cleansedCode": 100,
          "minLength": 0,
          "maxLength": 0
        }
      },
      "original": {
        "completePhoneNumber": "XXXXXXXXXXXX",
        "countryCode": "XX",
        "phoneNumber": "XXXXXXXXXX"
      }
    },
    "location": {
      "city": "Sample City",
      "state": "Sample State",
      "zip": "XXXXX",
      "metroCode": "XXXX",
      "county": "Sample County",
      "country": {
        "name": "Sample Country",
        "iso2": "XX",
        "iso3": "XXX"
      },
      "coordinates": {
        "latitude": 0.0,
        "longitude": 0.0
      },
      "timeZone": {
        "name": "Sample",
        "utcOffsetMax": "0",
        "utcOffsetMin": "0"
      }
    },
    "carrier": {
      "name": "Sample Carrier"
    },
    "contact": {
      "status": {
        "code": 2800,
        "description": "Request successfully completed"
      },
      "firstName": "",
      "lastName": "",
      "address1": "",
      "address2": "",
      "address3": "",
      "address4": "",
      "city": "",
      "stateProvince": "",
      "country": "XX",
      "zipPostalCode": "XXXXX",
      "emailAddress": "[email protected]",
      "dateOfBirth": "YYYY-MM-DD"
    }
  },
  "reason": "Request Successful",
  "code": "S001"
}

Parameter	Description	Data Type
result	Contains the phone intelligence and verification details returned by the API	Object
result.referenceId	Unique reference identifier generated for the transaction	String
result.externalId	External system identifier associated with the request	String
result.status	Overall status of the phone footprint transaction	Object
result.status.code	Numeric status code indicating transaction outcome	Number
result.status.description	Human-readable description of the transaction status	String
result.status.updatedOn	Date on which the transaction was last updated	String (YYYY-MM-DD)
result.phoneType	Indicates the type of phone number	Object
result.phoneType.code	Code representing the phone type	String
result.phoneType.description	Description of the phone type (e.g., MOBILE, LANDLINE)	String
result.blocklisting	Blocklisting information for the phone number	Object
result.blocklisting.blocked	Indicates whether the phone number is blocklisted	Boolean
result.blocklisting.blockCode	Code representing blocklisting status	Number
result.blocklisting.blockDescription	Description of the blocklisting status	String
result.numbering	Phone number normalization and cleansing details	Object
result.numbering.cleansing	Cleansed phone number information for call and SMS	Object
result.numbering.cleansing.call	Cleansed phone number details for call usage	Object
result.numbering.cleansing.sms	Cleansed phone number details for SMS usage	Object
result.numbering.original	Original phone number details as received	Object
result.location	Approximate geographic location associated with the phone number	Object
result.location.city	City associated with the phone number	String
result.location.state	State or region associated with the phone number	String
result.location.country	Country details associated with the phone number	Object
result.location.coordinates	Latitude and longitude of the approximate location	Object
result.location.timeZone	Time zone information for the phone number	Object
result.carrier	Carrier information associated with the phone number	Object
result.carrier.name	Name of the telecom carrier	String
result.contact	Contact enrichment details (if available)	Object
result.contact.status	Status of the contact enrichment request	Object
result.contact.status.code	Status code for contact enrichment	Number
result.contact.status.description	Description of contact enrichment status	String
reason	Describes the overall outcome of the API request	String
code	API response code indicating request success or failure	String

Error Code and Response Mapping

{
    "result": {},
    "reason": "Bad Request: phoneNumber is invalid",
    "code": "E001"
}


__________________________________________________________________

{
    "result": {},
    "reason": "Bad Request: originatingIp must be a valid IP address",
    "code": "E001"
}

____________________________________________________________________

{
    "result": {},
    "reason": "Bad Request: phoneNumber is required",
    "code": "E001"
}

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!