​
Phone Status Check - Detailed Documentation

The Identity Verification API is designed to verify identity information against stored data records from various databases. It provides a reliable way to ensure identity verification based on multiple data points, including personal information and address details.

​
API Playground:

You can try the identity verify endpoint here.

​
Endpoints Overview

  1. Verify Identity: Verify identity information by matching it against external and internal databases.

​
Authentication

To access the Address Verification API, authentication is required. A Bearer Token must be included in every request.

  • Tokens are valid for 60 minutes and must be refreshed after expiration.
  • Refer to the Authentication for detailed steps on obtaining a token.
  • Include the token in the Authorization header as follows:

Authorization: Bearer YOUR_ACCESS_TOKEN

​
API Base URL

https://api-umbrella.io/api/services

​
1. Verify Identity

​
Endpoint

POST /identity/verify

​
Description

This endpoint verifies identity information by matching it against external and internal databases.

​
Required Headers

HeaderValue
Content-Typeapplication/json
AuthorizationBearer yourAccessToken

​
Request Body Parameters

​
Response Structure

​
Response Codes

CodeDescription
200Successfully retrieved the verification results. Returns the verification data including total score and details of matches from various data sources.
400Invalid request provided.
401Authorization information is missing or invalid.

​
Global Result Table

FieldTypeDescription
totalScoreintegerAggregate score from the verification process. Values include:
0integerVerification failed.
50integerNo match found.
75integerPartial match, review needed.
100integerVerification successful.

​
Example Request

{
"raw": false, // Optional: Flag to request raw data return. Defaults to false.
"identity": {
  "firstName": "John", // Required: First name of the individual.
  "lastName": "Doe",   // Required: Last name of the individual.
  "nationalId": "123456789", // Required: National identification number.
  "birthDate": "1985/05/15"  // Required: Birthdate of the individual (format: yyyy/mm/dd).
},
"address": {
  "street": "Main Street", // Required: Street name of the address.
  "houseNumber": "123",    // Required: House or building number.
  "building": "Apt 4B",   // Optional: Building name or description.
  "postalCode": "10001",  // Required: Postal or ZIP code of the address.
  "city": "New York",     // Required: City of the address.
  "district": "Manhattan", // Optional: District or borough of the address.
  "province": "NY",       // Optional: Province or state of the address.
  "countryCode": "US"     // Required: ISO country code of the address.
},
"phone": {
  "phoneNumber": "+1234567890" // Optional: Phone number including international dialing code.
}
}