Check a token | INFONITE

Check whether a token can still be used, and what it is scoped to.

Worth calling before a batch run, and worth calling when a tokenized execution is refused: this is where the reason lives.

status_code, and what each one means for you

Status	What it means	What to do
`T10N_OK`	Ready. The last run authenticated.	Use it.
`T10N_KO`	Usable, but the last run did not complete.	Use it; if it keeps failing, ask for the credentials again.
`T10N_LOGIN_LOCK`	The source rejected the stored credentials, or locked the account.	Do not retry. Ask your customer for their access again and mint a new token.
`T10N_SYSTEM_LOCK`	Temporarily suspended by the platform.	Wait; if it persists, contact support.
`T10N_REVOKED`	Revoked. It will never run again.	Delete it and mint a new one.
`T10N_BROKEN`	The stored material can no longer be used.	Mint a new one.

context repeats the scope: engine_reference, customer_id, locking_hash and the features the token may request. date_expiration is the hard end of its life — 90 days from the exchange, not extended by use — after which the stored credentials are deleted.

The token key is never returned here. If you lost it, the token is unusable: revoke it and start over.

This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers.

Check whether a token can still be used, and what it is scoped to. Worth calling before a batch run, and worth calling when a tokenized execution is refused: this is where the reason lives. **`status_code`, and what each one means for you** | Status | What it means | What to do | | :--- | :--- | :--- | | `T10N_OK` | Ready. The last run authenticated. | Use it. | | `T10N_KO` | Usable, but the last run did not complete. | Use it; if it keeps failing, ask for the credentials again. | | `T10N_LOGIN_LOCK` | The source rejected the stored credentials, or locked the account. | Do not retry. Ask your customer for their access again and mint a new token. | | `T10N_SYSTEM_LOCK` | Temporarily suspended by the platform. | Wait; if it persists, contact support. | | `T10N_REVOKED` | Revoked. It will never run again. | Delete it and mint a new one. | | `T10N_BROKEN` | The stored material can no longer be used. | Mint a new one. | `context` repeats the scope: `engine_reference`, `customer_id`, `locking_hash` and the `features` the token may request. `date_expiration` is the hard end of its life — 90 days from the exchange, **not extended by use** — after which the stored credentials are deleted. The token **key** is never returned here. If you lost it, the token is unusable: revoke it and start over. > This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers.

Authentication

X-APP-SECRETstring

Application Secret

Path parameters

token_idstringRequiredformat: "object-id"

The stored-credentials token, as the exchange returned it.

Response

200 OK
What the token is for — the engine, the customer and the features it was scoped to — and whether it still works. It never carries the credentials, nor your key: nothing here can be turned back into a password.

token_idstringformat: "object-id"

Identifies the stored credentials — the same id you send when you run an execution with them.

date_createdstringformat: "datetime"

When the ticket was exchanged for this token.

date_expirationstringformat: "datetime"

When it stops working. Decided at the exchange and not extended by use: a token that runs every month still expires on this date, and a new one needs a new execution with credentials.

status_codeenum

Whether the token is usable. Branch on this, not on the dates.

contextobject

Credentials context.

status_descriptionstringOptional

Why it is in that state, in our words. Prose: read it, do not parse it.

status_messagestringOptional

A message written to be shown to a person, when there is one.

Errors

404

Not Found Error

422

Unprocessable Entity Error

Check whether a token can still be used, and what it is scoped to.

Worth calling before a batch run, and worth calling when a tokenized execution is refused: this is where the reason lives.

status_code, and what each one means for you

Status	What it means	What to do
`T10N_OK`	Ready. The last run authenticated.	Use it.
`T10N_KO`	Usable, but the last run did not complete.	Use it; if it keeps failing, ask for the credentials again.
`T10N_LOGIN_LOCK`	The source rejected the stored credentials, or locked the account.	Do not retry. Ask your customer for their access again and mint a new token.
`T10N_SYSTEM_LOCK`	Temporarily suspended by the platform.	Wait; if it persists, contact support.
`T10N_REVOKED`	Revoked. It will never run again.	Delete it and mint a new one.
`T10N_BROKEN`	The stored material can no longer be used.	Mint a new one.

The token key is never returned here. If you lost it, the token is unusable: revoke it and start over.

This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers.