Data Validation

Download OpenAPI specification:Download

Validate the identity data provided by your customers, such as their names, addresses, emails, and more. These APIs allow you to manage validation use cases, and run data validation processes.

NOTE: This service is currently preview only, and only available for customers upon request.

Get use cases

Retrieves all use cases that were created for data validation. Use cases determine the collection of validation services to use when processing a data validation request.

SecurityOAuth2: oauth2
Responses
200

Use cases found

401

Invalid authorization

get/v2/validation-use-cases
Request samples
Response samples
application/json
[
  • {
    }
]

Create use case

Creates a use case for data validation. Use cases determine the collection of validation services to use when processing a data validation request.

SecurityOAuth2: oauth2
Request
Request Body schema: application/json
required
display_name
required
string

Use case name that appears in the Admin Portal

description
required
string

Use case description

validation_services
required
Array of strings

List of validation services (IDs)

Items Enum: "GOOGLE_ADDRESS_VALIDATION" "EMAILHIPPO_MORE_EDITION_1" "EMAILHIPPO_MORE_EDITION_2" "MELISSA_GLOBAL_ADDRESS" "MELISSA_GLOBAL_NAME" "MELISSA_GLOBAL_EMAIL" "MELISSA_GLOBAL_PHONE" "MELISSA_PERSONATOR_CONSUMER" "MELISSA_PERSONATOR_IDENTITY" "TELESIGN_PHONE_ID_CONTACT" "TELESIGN_INTELLIGENCE"
Responses
200

Use case created

400

Bad Request

401

Invalid authorization

post/v2/validation-use-cases
Request samples
application/json
{
  • "display_name": "string",
  • "description": "string",
  • "validation_services": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "display_name": "string",
  • "description": "string",
  • "validation_services": [
    ],
  • "mandatory_fields": [
    ],
  • "optional_fields": [
    ],
  • "tags": [
    ]
}

Get use case

Retrieves a specific data validation use case by ID

SecurityOAuth2: oauth2
Request
path Parameters
use_case_id
required
string

Use case ID

Responses
200

Use case found

401

Invalid authorization

404

use_case_id not found

get/v2/validation-use-cases/{use_case_id}
Request samples
Response samples
application/json
{
  • "id": "string",
  • "display_name": "string",
  • "description": "string",
  • "validation_services": [
    ],
  • "mandatory_fields": [
    ],
  • "optional_fields": [
    ],
  • "tags": [
    ]
}

Update use case

Updates a specific data validation use case

SecurityOAuth2: oauth2
Request
path Parameters
use_case_id
required
string

Use case ID

Request Body schema: application/json
required
display_name
string

Use case name that appears in the Admin Portal

description
string

Use case description

validation_services
Array of strings

List of validation services (by ID)

Items Enum: "GOOGLE_ADDRESS_VALIDATION" "EMAILHIPPO_MORE_EDITION_1" "EMAILHIPPO_MORE_EDITION_2" "MELISSA_GLOBAL_ADDRESS" "MELISSA_GLOBAL_NAME" "MELISSA_GLOBAL_EMAIL" "MELISSA_GLOBAL_PHONE" "MELISSA_PERSONATOR_CONSUMER" "MELISSA_PERSONATOR_IDENTITY" "TELESIGN_PHONE_ID_CONTACT" "TELESIGN_INTELLIGENCE"
Responses
200

Use case updated

400

Bad Request

401

Invalid authorization

404

use_case_id not found

put/v2/validation-use-cases/{use_case_id}
Request samples
application/json
{
  • "display_name": "string",
  • "description": "string",
  • "validation_services": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "display_name": "string",
  • "description": "string",
  • "validation_services": [
    ],
  • "mandatory_fields": [
    ],
  • "optional_fields": [
    ],
  • "tags": [
    ]
}

Delete use case

Deletes a specific data validation use case

SecurityOAuth2: oauth2
Request
path Parameters
use_case_id
required
string

Use case ID

Responses
204

Use case deleted

401

Invalid authorization

404

use_case_id not found

delete/v2/validation-use-cases/{use_case_id}
Request samples

Get use case suggestions

Retrieves suggestions for use cases, which can be copied to create a new use case via POST /v2/validation-use-cases. Use cases determine the collection of validation services to use when processing a data validation request.

SecurityOAuth2: oauth2
Responses
200

List of use case suggestions

401

Invalid authorization

get/v2/use-case-suggestions
Request samples
Response samples
application/json
[
  • {
    }
]

Validate data

Validate identity data provided by the user. Validations will be performed according to the specified use case, which determines which validation services will be used and which data fields must be provided in the request. The response contains the aggregated result returned from all the validation services. It must be called from the client backend.

SecurityOAuth2: oauth2
Request
Request Body schema: application/json
required
use_case_id
required
string

Use case ID

required
object

Data to validate

Responses
200

Data validation finished successfully

400

Bad Request

401

Invalid authorization

post/v2/api/validate-data
Request samples
application/json
{
  • "use_case_id": "string",
  • "data": {
    }
}
Response samples
application/json
[
  • {
    }
]