Umbrella Docs
© 2024 IDCanopy Flexco

Identity Verification API (2 by 2)

identity verification v1.0.0 mdx

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 Version

Version: 1.0.0

API Base URL

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

Endpoints: /identity/verify

Method: POST

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

Request Body Raw

  • raw (boolean): Optional. Flag to request raw data return. Defaults to false.
  • identity (object): Required. Contains the personal identification details.
    • firstName (string): First name of the individual.
    • lastName (string): Last name of the individual.
    • nationalId (string): National identification number.
    • birthDate (string, date): Birthdate of the individual. Format: MM/DD/YYYY.
  • address (object): Required. Contains address details.
    • street (string): Street name of the address.
    • houseNumber (string): House or building number.
    • building (string): Building name or description.
    • postalCode (string): Postal or ZIP code of the address.
    • city (string): City of the address.
    • district (string): District or borough of the address.
    • province (string): Province or state of the address.
    • countryCode (string): ISO country code of the address.
  • phone (object): Optional. Contains phone contact details.
    • phoneNumber (string): Phone number including international dialing code.

Responses

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

Data Objects

IdentityVerificationRequest

Schema object for request body details as listed above under Request Body.

IdentityVerificationResponse

Schema object for response data including:

  • globalResult (object): Contains the aggregate score from the verification process.
  • resultDetails (array): Lists detailed match results from various data sources.

GlobalResult

  • totalScore (integer): Aggregate score from the verification process. Values include:
    • 0: Verification failed
    • 50: No match found
    • 75: Partial match, review needed
    • 100: Verification successful

ResultDetail

  • datasource (string): Identifier for the data source used in verification.
  • country (string): Country associated with the data source.
  • matches (array of MatchRecord): Detailed match results.

MatchRecord

  • record (string): Type of record matched.
  • match (string): Result of the match against the record. Possible values:
    • "full": Full match
    • "partial": Partial match
    • "not-present": Record not present in the data source.