Request an enrichment by combining multiple products all in a single endpoint to feed complex scoring models.

REQUEST

🚧

Mandatory fields

Field can become mandatory depending on the provided claim

When providing a set of claims the fido product API will perform validation on multiple fields, depending on the request.

🚧

Async data

The webhook URL is not mandatory but some values may not be available in the first request, you need to specify a webhook URL to receive all the data. Those values are marked in the response field documentation

AVAIABLE CLAIMS

Claims are a way to request a combination of products by only invoking

Claim

Description

phone

Enable Fido Phone

email

Enable Fido Email

name

Enable Fido Name

device

Enable Fido Device

browser

Enable Fido Browser (Fido JS required)

ip

Enable Fido IP

score

Enable a model based on Fido Products

RESPONSE

For a full description of the fields you can look at the individual products:

SCORE BLOCK

The score block is specific for this use case. While all other products will still produce a specific score this block will display a score build using a model that takes into account all singles modules.

It's more than just a sum of the individual scores as it takes into account cross-product signals and it's trained

name

type

score

int

A number ranging from 0 to 1000

ex: 649

score_cluster

string

A cluster summarizing the score above.

Examples:

poor
bad
moderate
good
high

FAQ

📘

What happens if I pass the same customer_id on multiple requests?

The customer_id is needed for the identity resolution. All the requests with the same customer id will be
merged into the same user document, potentially updating the data.

📘

How long does it take to get notified via the webhook endpoint?

The notification will be sent within 5 minutes of the API call. Multiple calls may be sent in case of an update, the last call will always contain the full set of information. After 5 minutes you can consider the result as final.

📘

Why did I get a 401 "Unauthorized" response?

This may happen if you correctly populated the API key field but the key is either incorrect or not enabled.

Language
Authentication
Header
Click Try It! to start a request and see the response here!