HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Create a validation and the link the customer opens

Create a pending validation from the caller's own configuration and return its link.

The organization's own surface, reached server-to-server with an api-key, and the only one where the caller chooses validator_config — there the caller is the organization, so configuring its validation is its call.

The execution starts PENDING and nothing runs here, so the front begins from zero. The customer may open the link hours later, and a session token minted now would already be expired.

Idempotent while the execution is active, so a retried call hands back the same link rather than minting a second one — and a repeat is a 200 while only the first call is a 201.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body the organization sends to mint a validation link, server-to-server with api-key.

The only surface where the caller chooses validator_config: it is the organization's own validation being configured, not a browser choosing its checks. There is no risk_flow here — this creation is not part of a journey, so nothing resolves the config and the caller supplies it.

ExecutionContext | object

Where and under what terms the validation was run. The one context that is not per validator: nothing in it is about what is being validated.

string
required
length ≥ 1

The caller's own correlation key. It travels out in the result webhook, so it must be an id the organization is willing to see there.

string
required
length ≥ 1

The organization's portal the customer will be sent to. It has to be one this organization has registered — a portal it does not own is a 422.

IdentityValidationContext | SignatureValidationContext | object

What was declared about the customer, frozen into the execution. Which shape applies is decided by the validator: a context that is not what its validator accepts is refused with INVALID_VALIDATION_CONTEXT, naming the fields that failed and never their values.

string
required
length ≥ 1

Which validator to run.

validator_config
object
required

The validator's configuration, frozen into the execution as given. A later edit of it cannot change a validation already in flight.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json