TRtrustfull
Products

Trustfull Email

Changed on

Trustfull Email

post/email

Request

  • Base URL
    https://api.fido.id/1.0
  • URL
    https://api.fido.id/1.0/email
  • Auth
    none declared. Required headers: x-api-key

Headers

content-typestring
acceptstring
x-api-keystring required
Example:[your-api-key]
x-demostring

Request body

customer_idstring required

A string representing the unique identifier of the user you are requesting information about. Each request requires a different customer_id

max_enrichment_timenumber float

Specifies the maximum duration for data enrichment, allowing you to fine-tune the process to enhance accuracy or reduce response time. Read more

model_idstring

The id of the model that computes the score: one of your models, or a system model such as phone_score. The model must score the product of the call. Leave it out to use the active model of the product.

emailstring required

Email address you want to lookup.

claimsstring[] required

Example request

{
  "customer_id": "customer_id_393494108457",
  "max_enrichment_time": 3,
  "model_id": "c0a8f3e2-4b1d-4e8a-9f2a-7d1e2b3c4d5e",
  "email": "email@example.com",
  "claims": [
    "email"
  ]
}

Response

OK

resolution_idstring
device_request_timestring
customer_idCustomerId (unresolved $ref)
model_idstring nullable

The id of the model that computed the score of the response. It is null when no model computed a score.

Changes

  • be8ae1d26648Revision changes
    • warning

      added the new accept_all enum value to the // response property for the response status

    • warning

      added the new catch-all_ai_agent_mailbox enum value to the // response property for the response status

    • warning

      added the new deliverable enum value to the // response property for the response status

    • warning

      added the new invalid enum value to the // response property for the response status

    • warning

      added the new possible_typo enum value to the // response property for the response status

    • warning

      added the new risky_promoted enum value to the // response property for the response status

    • warning

      added the new role enum value to the // response property for the response status

    • warning

      added the new safe_to_send_promoted enum value to the // response property for the response status

    • warning

      added the new spam-trap enum value to the // response property for the response status

    • warning

      added the new spam_track enum value to the // response property for the response status

    • warning

      added the new valid__promoted enum value to the // response property for the response status

    • warning

      added the new valid_accept_all_promoted enum value to the // response property for the response status

    • warning

      added the new valid_ai_agent_mailbox enum value to the // response property for the response status

    • warning

      added the new valid_gold enum value to the // response property for the response status

    • warning

      added the new valid_role_promoted enum value to the // response property for the response status

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status