> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Gerar token SDK de monitorização da API > Gere na Didit uma credencial de dispositivo de curta duração, ligada a um sujeito, para enviar eventos de monitorização sem expor a chave de API. Prompt da API para emitir um token do SDK de monitorização Copiar o prompt para a área de transferência \

\`Mint a short-lived device credential so my web or mobile app can send monitoring events for one user straight to Didit.

Endpoint:
POST https://verification.didit.me/v3/events/sdk-token/

Authentication:
Use the x-api-key header with my Didit API key. This call runs on MY BACKEND only - the API key must never ship in an app. Only the returned monitoring_token travels to the device. A scoped key needs transactions: write.

Goal:
\- Get a monitoring_token for the signed-in user. The app sends it in the X-Monitoring-Token header to the device lane (POST /v1/events/ and POST /v1/events/batch/).

Request body (application/json):
\{
"vendor_data": "user-42",                                  // required - the subject every event belongs to
"entity_type": "individual",                               // optional - company binds a company; any other value an individual (default)
"allowed_event_categories": ["auth", "session", "gameplay"], // optional - omit or [] for every category
"ttl_seconds": 900,                                        // optional - 60 to 86400, default 900
"max_uses": 1000,                                          // optional - events it may submit, default 1000, null for no cap
"bind_to_origin": "https://app.example.com"                // optional - browser Origin must match exactly
}
camelCase aliases (vendorData, entityType, allowedEventCategories, ttlSeconds, maxUses, bindToOrigin) are also accepted.

Behavior:
\- The subject is bound server-side: whatever subject the app sends is overwritten with vendor_data.
\- One use per submitted event, also inside a batch: a 500-event flush spends 500 uses, and events the device lane rejects spend uses too.
\- An event outside allowed_event_categories is rejected by the device lane with 400.
\- With bind_to_origin set, a device request with a different Origin, or none, is refused.
\- Minting does not create a user.
\- Event ingestion must be switched on for the application, otherwise this call returns 403 with code event_monitoring_disabled.

Example call:
curl -X POST "https://verification.didit.me/v3/events/sdk-token/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"vendor_data":"user-42","allowed_event_categories":["auth","session","gameplay"],"ttl_seconds":900,"max_uses":1000}'

What to read from the response:
\- monitoring_token - hand it to the app; treat it as a secret for its lifetime.
\- expires_at - mint a fresh credential per user session before it expires.
\- allowed_event_categories ([] means every category), max_uses (null means no cap), bind_to_origin.

Failure modes:
\- 400 - missing vendor_data, ttl_seconds outside 60-86400, max_uses below 1, or an unknown category.
\- 401 - the API key has expired.
\- 403 - missing API key (a wrong, revoked or expired key gets 401), a scoped key without transactions: write, or code event_monitoring_disabled.

Side effects: creates one credential. Nothing else changes.

For the full client-side submission guide, see /transaction-monitoring/sdk-event-submission.`

\
Colar em A credencial é utilizada pelo canal do dispositivo, descrito em [Envio de eventos do SDK](https://docs.didit.me/pt/transaction-monitoring/sdk-event-submission.md), que também indica o que o servidor aplica em cada pedido do dispositivo e quais os eventos que podem ser descartados com segurança em situações de contrapressão. ## OpenAPI ````yaml pt/openapi-25.json POST /v3/events/sdk-token/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/events/sdk-token/: post: tags: - Monitoring Events summary: Emitir um token do SDK de monitorização description: >- Emita uma credencial de dispositivo de curta duração vinculada a um sujeito, para que a sua aplicação web ou móvel possa enviar os eventos desse utilizador diretamente para a Didit sem uma chave de API. A aplicação envia o `monitoring_token` retornado no cabeçalho `X-Monitoring-Token` para a via de dispositivos (`POST /v1/events/` e `POST /v1/events/batch/`), onde o sujeito é sempre substituído por este `vendor_data`, eventos fora de `allowed_event_categories` são rejeitados, cada evento submetido gasta uma utilização e um pedido cujo `Origin` não seja igual a `bind_to_origin` é recusado. Chame-o apenas a partir do seu backend; a emissão cria a credencial e nada mais (nenhum utilizador é criado). A ingestão de eventos tem de estar ativada para a aplicação, caso contrário este endpoint devolve `403` com `code: event_monitoring_disabled` em vez de emitir uma credencial que nunca conseguiria escrever. Uma chave de API com âmbito precisa de `transactions: write`. Consulte [Submissão de eventos pelo SDK](https://docs.didit.me/pt/transaction-monitoring/sdk-event-submission). operationId: create_monitoring_event_sdk_token requestBody: required: true content: application/json: schema: type: object description: >- São aceites aliases em camelCase: `vendorData`, `entityType`, `allowedEventCategories`, `ttlSeconds`, `maxUses`, `bindToOrigin`. required: - vendor_data properties: vendor_data: type: string minLength: 1 maxLength: 255 description: >- O seu id para o sujeito ao qual pertence cada evento enviado com esta credencial. entity_type: type: string maxLength: 32 default: individual description: >- `company` vincula um sujeito do tipo empresa; qualquer outro valor (por predefinição `individual`) vincula um indivíduo. allowed_event_categories: type: array items: type: string enum: - auth - session - gameplay - bonus - affiliate - payment - dispute - security - responsible_gambling - custom description: >- Categorias que a credencial pode submeter. Omita ou envie `[]` para permitir todas as categorias. ttl_seconds: type: integer minimum: 60 maximum: 86400 default: 900 description: Tempo de vida da credencial em segundos. max_uses: type: integer minimum: 1 nullable: true default: 1000 description: >- Número de eventos que a credencial pode submeter (um lote consome uma utilização por evento). Envie `null` para não ter limite durante o período de validade. bind_to_origin: type: string maxLength: 255 nullable: true description: >- Quando definido, o cabeçalho `Origin` do navegador de cada pedido do dispositivo deve ser exatamente igual a este valor; um pedido sem `Origin` é recusado. example: vendor_data: user-42 allowed_event_categories: - auth - session - gameplay ttl_seconds: 900 max_uses: 1000 bind_to_origin: https://app.example.com responses: '201': description: >- A credencial foi emitida. Transmita o `monitoring_token` para a aplicação e trate-o como segredo até `expires_at`. content: application/json: schema: type: object required: - monitoring_token - expires_at - allowed_event_categories - max_uses - bind_to_origin properties: monitoring_token: type: string description: >- A credencial do dispositivo (um token de 43 carateres compatível com URL). Envie-a no cabeçalho `X-Monitoring-Token`. expires_at: type: string format: date-time description: Quando a credencial deixa de ser aceite. allowed_event_categories: type: array items: type: string enum: - auth - session - gameplay - bonus - affiliate - payment - dispute - security - responsible_gambling - custom description: >- Categorias que a credencial pode submeter; `[]` significa todas as categorias. max_uses: type: integer nullable: true description: >- Orçamento de eventos da credencial; null significa sem limite. bind_to_origin: type: string nullable: true description: Origem à qual a credencial está vinculada, ou null. example: monitoring_token: q7ZtR2xKp9VbN4mWc8LdH1sYfJ3gT6uEaQ0oPiXzBkC expires_at: '2026-10-17T09:30:02.481000Z' allowed_event_categories: - auth - session - gameplay max_uses: 1000 bind_to_origin: https://app.example.com '400': description: >- A validação falhou: `vendor_data` em falta, `ttl_seconds` fora do intervalo de 60 a 86400, `max_uses` inferior a 1 ou uma categoria desconhecida (indexada pela sua posição no array). content: application/json: examples: Missing vendor_data: value: vendor_data: - This field is required. ttl_seconds too short: value: ttl_seconds: - Ensure this value is greater than or equal to 60. Unknown category: value: allowed_event_categories: '1': - '"login" is not a valid choice.' '401': description: >- A chave de API com âmbito expirou. Apenas uma chave expirada recebe `401`; uma chave em falta ou inválida recebe `403`. content: application/json: examples: Expired key: value: detail: This API key has expired. '403': description: >- Um `x-api-key` em falta (uma chave incorreta, revogada ou expirada obtém `401`), uma chave com âmbito restrito sem `transactions: write`, uma chave limitada a alguns fluxos ou a sessões aprovadas (tal chave nunca acede a dados de monitorização de transações), ou um pedido fora da lista de permissões de IP da chave. Também devolvido com `code: event_monitoring_disabled` enquanto a ingestão de eventos estiver desativada para a aplicação; nada é armazenado nesse caso, e a verificação é executada antes da validação do corpo. content: application/json: examples: Event monitoring disabled: value: detail: >- Event monitoring is not enabled for this application. Turn on event ingestion in the transaction monitoring settings before submitting events. code: event_monitoring_disabled Missing or invalid API key: value: detail: You do not have permission to perform this action. Scoped key without access: value: detail: This API key has no write access to transactions. Key limited to workflows or approved sessions: value: detail: >- This API key only reaches sessions inside its workflow or status limits, so it can't use this endpoint. IP not allowed: value: detail: This API key can't be used from this IP address. '429': description: >- Limite de pedidos excedido: os pedidos de escrita (`POST`, `PATCH`, `DELETE`) partilham um orçamento de 300 pedidos por minuto por chave de API. Aguarde `Retry-After` segundos e, em seguida, tente novamente. headers: Retry-After: description: Segundos a aguardar antes de tentar novamente. schema: type: integer minimum: 1 example: 30 content: application/json: examples: Throttled: value: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X POST 'https://verification.didit.me/v3/events/sdk-token/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "vendor_data": "user-42", "allowed_event_categories": ["auth", "session", "gameplay"], "ttl_seconds": 900, "max_uses": 1000, "bind_to_origin": "https://app.example.com" }' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.monitoring_events.create_sdk_token( vendor_data="user-42", allowed_event_categories=["auth", "session", "gameplay"], ttl_seconds=900, max_uses=1000, bind_to_origin="https://app.example.com", ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.monitoringEvents.createSdkToken({ vendor_data: "user-42", allowed_event_categories: ["auth", "session", "gameplay"], ttl_seconds: 900, max_uses: 1000, bind_to_origin: "https://app.example.com", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.MonitoringEvents.CreateSDKToken(ctx, didit.MonitoringEventsCreateSDKTokenParams{\n\tVendorData: \"user-42\",\n\tAllowedEventCategories: didit.Some([]didit.MonitoringEventsCreateSDKTokenParamsAllowedEventCategories{\"auth\", \"session\", \"gameplay\"}),\n\tTTLSeconds: didit.Int(900),\n\tMaxUses: didit.Int(1000),\n\tBindToOrigin: didit.String(\"https://app.example.com\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import java.util.List; import me.didit.Didit; import me.didit.types.MonitoringEventsCreateSdkTokenParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.monitoringEvents().createSdkToken(MonitoringEventsCreateSdkTokenParams.builder() .vendorData("user-42") .allowedEventCategories(List.of(MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of("auth"), MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of("session"), MonitoringEventsCreateSdkTokenParams.AllowedEventCategories.of("gameplay"))) .ttlSeconds(900L) .maxUses(1000L) .bindToOrigin("https://app.example.com") .build()); System.out.println(result); - lang: php label: PHP source: |- monitoringEvents->createSdkToken([ 'vendor_data' => 'user-42', 'allowed_event_categories' => ['auth', 'session', 'gameplay'], 'ttl_seconds' => 900, 'max_uses' => 1000, 'bind_to_origin' => 'https://app.example.com', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.monitoring_events.create_sdk_token( vendor_data: "user-42", allowed_event_categories: ["auth", "session", "gameplay"], ttl_seconds: 900, max_uses: 1000, bind_to_origin: "https://app.example.com" ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.MonitoringEvents.CreateSdkTokenAsync(new MonitoringEventsCreateSdkTokenParams { VendorData = "user-42", AllowedEventCategories = new MonitoringEventsCreateSdkTokenParamsAllowedEventCategories[] { "auth", "session", "gameplay" }, TtlSeconds = 900, MaxUses = 1000, BindToOrigin = "https://app.example.com", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.