> ## 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. # Reivindicar entrada no diretório: Travel Rule gratuita > Na API de gerenciamento da Didit, reivindique a entrada do diretório Travel Rule do seu workspace e entre gratuitamente como VASP contraparte. Prompt de API para reivindicar uma entrada do diretório Copiar o prompt para a área de transferência \

\``Claims the directory entry this workspace is. When the work email is at a domain the entry lists, the claim is proved and applies at once: the VASP profile and Travel Rule settings are filled from the entry and Travel Rule is turned on, so the next transfer to it routes over the Didit network. Otherwise the claim waits for review (`pending_review`).

Endpoint:
POST https://verification.didit.me/v3/travel-rule/workspace/claim/

Authentication:
Use the x-api-key header with the API key returned when the account was created.

Request body (application/json):
\{"vasp_id": "0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11"}

Failure modes:
\- 400 - No directory entry has this id.
\- 404 - This application did not join free, so it has no free workspace.

Guide: /transaction-monitoring/travel-rule-interoperability#email-pickup.``

\
Colar em ## OpenAPI ````yaml pt-br/openapi-25.json POST /v3/travel-rule/workspace/claim/ 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/travel-rule/workspace/claim/: post: tags: - Travel Rule summary: Reivindicar uma entrada do diretório description: >- Reivindica a entrada do diretório que corresponde a este workspace. Quando o e-mail corporativo pertence a um domínio listado na entrada, a reivindicação é comprovada e aplicada imediatamente: o perfil de VASP e as configurações de Travel Rule são preenchidos a partir da entrada e a Travel Rule é ativada, de modo que a próxima transferência para ela é roteada pela rede da Didit. Caso contrário, a reivindicação aguarda revisão (`pending_review`). operationId: claimTravelRuleWorkspace requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TravelRuleWorkspaceClaimRequest' example: vasp_id: 0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11 responses: '200': description: O workspace com o status de reivindicação. content: application/json: schema: $ref: '#/components/schemas/TravelRuleWorkspace' '400': description: Nenhuma entrada do diretório tem este id. '404': description: >- Esta aplicação não entrou pelo plano gratuito, portanto não tem um workspace gratuito. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X POST https://verification.didit.me/v3/travel-rule/workspace/claim/ \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"vasp_id": "0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.travel_rule.workspace.claim( vasp_id="0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11", ) 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.travelRule.workspace.claim({ vasp_id: "0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.Workspace.Claim(ctx, didit.TravelRuleWorkspaceClaimRequest{\n\tVASPID: \"0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.TravelRuleWorkspaceClaimRequest; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.travelRule().workspace().claim(TravelRuleWorkspaceClaimRequest.builder() .vaspId("0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11") .build()); System.out.println(result); - lang: php label: PHP source: |- travelRule->workspace->claim([ 'vasp_id' => '0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.travel_rule.workspace.claim(vasp_id: "0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11") 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.TravelRule.Workspace.ClaimAsync(new TravelRuleWorkspaceClaimRequest { VaspId = "0b0c9d3e-5a53-4a3e-9d6e-1f2f6f6a1c11", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: TravelRuleWorkspaceClaimRequest: type: object required: - vasp_id properties: vasp_id: type: string format: uuid description: >- A entrada do diretório que corresponde a este espaço de trabalho. Leia os ids em `GET /v3/travel-rule/vasps/`. TravelRuleWorkspace: type: object description: >- O espaço de trabalho gratuito de Travel Rule de uma aplicação que aderiu gratuitamente. properties: joined_free: type: boolean work_email: type: string format: email joined_at: type: string format: date-time nullable: true claim: type: object properties: status: type: string enum: - unclaimed - pending_review - claimed - rejected proved_by_domain: type: boolean claimed_at: type: string format: date-time nullable: true reviewed_at: type: string format: date-time nullable: true review_note: type: string vasp_id: type: string format: uuid nullable: true vasp_name: type: string prefill: type: object description: >- Valores do perfil obtidos da entrada do diretório: `vasp_id`, `legal_name`, `lei`, `jurisdiction`, `compliance_email`, `domains`. Nada é gravado até que a reivindicação seja feita. domain: type: object properties: domain: type: string status: type: string enum: - unverified - code_sent - verified verified_at: type: string format: date-time nullable: true txt: $ref: '#/components/schemas/TravelRuleWorkspaceTxtRecord' billing_enabled: type: boolean description: >- Receber dados da Travel Rule é gratuito. O envio só é cobrado depois que o faturamento é ativado. billing_enabled_at: type: string format: date-time nullable: true didit_network: type: object description: >- Indica se a rede Didit lista este VASP e, caso não liste, cada condição que ainda falta cumprir. settings: $ref: '#/components/schemas/TravelRuleSettingsDetail' TravelRuleWorkspaceTxtRecord: type: object description: >- O registro TXT a ser publicado para a prova por DNS. Fica vazio até que uma prova seja iniciada. properties: host: type: string example: didit-tr-verify.example.com value: type: string TravelRuleSettingsDetail: type: object properties: is_enabled: type: boolean description: >- Se o fluxo gerenciado de negociação da Travel Rule está ativo para transações `travelRule` de saída nesta aplicação. jurisdiction: type: string maxLength: 8 description: >- Código da jurisdição em que sua VASP opera. Padrão `"EU"`. A Didit o associa ao regime que registra nas suas transações de Travel Rule como `travel_rule_regime` (por exemplo, `EU` ou o código de um Estado-membro da UE se torna `eu`), que as regras de transação podem usar como critério. Outros clientes da Didit o veem como sua jurisdição no diretório de VASPs assim que a rede Didit listar seu perfil. name_matching_strictness: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: >- Com que rigor os nomes dos beneficiários devem corresponder antes que uma transferência possa chegar a COMPLETED. `CONTAINS` aceita um nome cujas palavras aparecem todas no outro. confirmation_timeout_hours: type: integer minimum: 1 description: >- Horas que uma transferência AWAITING_COUNTERPARTY pode permanecer sem confirmação antes que o processo periódico de varredura a expire. Padrão: 48. timeout_outcome: type: string enum: - HOLD - REJECT - PROCEED description: >- O que acontece com a transação subjacente quando uma transferência expira. Padrão: HOLD. sunrise_policy e non_responsive_policy têm precedência quando se aplicam e estão definidas. threshold_amount: type: string description: >- String decimal, na moeda padrão da sua aplicação. Valor mínimo de transferência que aciona uma troca gerenciada; transferências abaixo dele são resolvidas diretamente como NOT_APPLICABLE. A Didit compara o valor da transação convertido para a sua moeda padrão, ou o `amount_in_default_currency` que você envia; quando nenhum valor convertido está disponível, o limiar não se aplica. O padrão é "0.00" (o EU TFR não aplica valor mínimo). ownership_validation_mode: type: string enum: - FULL - SIMPLIFIED - AUTOMATED description: >- Quanta comprovação a propriedade de uma carteira exige. `FULL` sempre exige uma comprovação (mensagem assinada, depósito de teste ou captura de tela revisada), nunca a palavra do usuário final. `SIMPLIFIED` aceita uma autodeclaração abaixo de `simplified_validation_threshold` e uma comprovação acima dele. `AUTOMATED` permite que o catálogo de endereços e as comprovações anteriores respondam por conta própria, incluindo autodeclarações enquanto `allow_self_declaration` for true. Padrão `AUTOMATED`. simplified_validation_threshold: type: string description: >- String decimal, padrão "0.00". No modo `SIMPLIFIED`, uma transferência abaixo desse valor (na moeda do limiar) aceita uma autodeclaração. Uma transferência sem valor nessa moeda conta como acima dele. data_sharing_fields: $ref: '#/components/schemas/TravelRuleDataSharingFields' matching_rules: $ref: '#/components/schemas/TravelRuleMatchingRules' legal_name: type: string description: >- Razão social do seu VASP. Obrigatório (não pode ficar em branco) para definir is_enabled como true. lei: type: string description: Seu Legal Entity Identifier, exibido no diretório de VASPs. compliance_email: type: string format: email description: >- E-mail de contato de conformidade do seu perfil de VASP. A rede Didit só lista seu perfil depois que esse endereço é confirmado por meio de um link enviado por e-mail (POST /v3/travel-rule/settings/compliance-email/confirmation/); alterá-lo exige uma nova confirmação. is_discoverable: type: boolean description: >- Se o seu perfil de VASP pode ser listado na rede Didit: encontrado em GET /v3/travel-rule/vasps/ por outros clientes da Didit e acessado pelo rail INTERNAL. A listagem também exige uma aplicação de produção, a Travel Rule ativada, uma razão social e um e-mail de conformidade confirmado; didit_network indica quais deles estão faltando. Padrão: true. inbound_auto_accept: type: boolean description: >- Quando verdadeiro, uma consulta TRP de entrada cuja carteira do beneficiário é uma entrada verificada do catálogo de endereços com nome correspondente é aprovada automaticamente. Quando falso, essa consulta fica em ON_HOLD até que você a aprove ou recuse com o endpoint de propriedade. Transferências pela via INTERNAL e após depósito não são afetadas. Padrão: verdadeiro. allow_self_declaration: type: boolean description: >- Quando verdadeiro, o widget de propriedade de carteira oferece a autodeclaração como método de prova alternativo. Padrão: verdadeiro. allow_screenshot_proof: type: boolean description: >- Quando verdadeiro, o widget de propriedade de carteira oferece o envio de captura de tela como método de evidência de propriedade. Padrão: verdadeiro. auto_wallet_verification: type: boolean description: >- Quando verdadeiro, o envio de uma transferência de saída da Travel Rule que exige prova de controle da carteira pelo usuário final cria automaticamente uma sessão do widget de propriedade de carteira vinculada à transação e a expõe no bloco action_required da transação. Padrão: verdadeiro. vasp_attribution_enabled: type: boolean description: >- Quando verdadeiro, uma transferência de saída da Travel Rule que nenhuma via consegue rotear é atribuída por meio de análise de blockchain: a carteira de destino é associada ao VASP que a controla, a entidade é registrada na transferência e no diretório de VASPs, e as vias são executadas novamente uma vez com o nome atribuído. Padrão: verdadeiro. counterparty_screening_enabled: type: boolean description: >- Análise opcional de sanções e mídia adversa de VASPs contraparte, cobrada por análise ao preço da Análise AML de empresas. Quando ativada, a Didit analisa a contraparte alcançada por uma troca de saída (reutilizando uma análise com menos de 30 dias) e você pode analisar uma com POST /v3/travel-rule/vasps/{vasp_id}/screening/. Padrão false: nada é analisado nem cobrado. sunrise_policy: type: string enum: - '' - HOLD - REJECT - PROCEED description: >- O efeito de uma transferência expirada sobre a sua transação quando a contraparte é uma entrada do diretório em uma jurisdição listada em sunrise_jurisdictions, que ainda não aplica a Travel Rule: HOLD a envia para revisão, REJECT a recusa, PROCEED mantém o status dela inalterado. Vazio (o padrão) segue timeout_outcome. Aplica-se antes de non_responsive_policy. sunrise_jurisdictions: type: array items: type: string readOnly: true description: >- Somente leitura. Os países (ISO 3166 alpha-2) que a Didit considera em período de sunrise da Travel Rule, nos quais sunrise_policy se aplica. Atualmente CO, KH e VN. Qualquer outra jurisdição, assim como uma vazia ou desconhecida, segue timeout_outcome. non_responsive_policy: type: string enum: - '' - HOLD - REJECT - PROCEED description: >- O efeito de uma transferência expirada sobre a sua transação quando a contraparte é uma entrada do diretório cuja responsividade é UNRESPONSIVE: HOLD, REJECT ou PROCEED, como em timeout_outcome. Vazio (o padrão) segue timeout_outcome. sunrise_policy se aplica primeiro quando ambas se encaixam. travel_address: type: string description: >- Somente leitura. O travel address do seu próprio VASP - o endpoint codificado de consultas TRP de entrada que outros VASPs usam para chegar até você. Vazio enquanto `is_enabled` for false. disabled_networks: type: array items: type: string enum: - GTR - TRUST - VERIFYVASP - SYGNA description: >- Redes em que a associação da plataforma foi desativada (opt-out). Não desativa as suas próprias associações conectadas nem provisiona redes indisponíveis. default: [] networks: type: object readOnly: true description: >- Por rede, como esta aplicação faria o envio e por que não consegue. Nenhuma rede, incluindo a GTR, é incluída por padrão: uma rede fica acessível por meio da sua própria associação conectada, ou por meio da associação da Didit assim que a associação da Didit a essa rede estiver ativa e o seu próprio participante nela estiver ativo. Não é uma verificação em tempo real de funcionamento ou de entrega. properties: gtr: $ref: '#/components/schemas/TravelRuleNetworkState' trust: $ref: '#/components/schemas/TravelRuleNetworkState' verifyvasp: $ref: '#/components/schemas/TravelRuleNetworkState' sygna: $ref: '#/components/schemas/TravelRuleNetworkState' didit_network: type: object readOnly: true description: >- Se a rede Didit lista o seu perfil de VASP, para que outros clientes da Didit o encontrem no diretório e o alcancem pelo trilho INTERNAL, e cada condição que ainda não é atendida. properties: listed: type: boolean missing: type: array items: type: string enum: - travel_rule_off - sandbox_application - not_discoverable - legal_name_missing - compliance_email_missing - compliance_email_unconfirmed - excluded_by_staff - internal_organization description: >- Vazio quando listado. compliance_email_unconfirmed: envie a confirmação com POST /v3/travel-rule/settings/compliance-email/confirmation/ e abra o link recebido por e-mail. excluded_by_staff: a Didit marcou a aplicação como de teste, de demonstração ou interna. compliance_email_confirmed: type: boolean description: >- Se o compliance_email atual foi confirmado pelo link enviado por e-mail. TravelRuleDataSharingFields: type: object description: >- Os campos que a Didit envia à VASP contraparte sobre seus próprios usuários, por tipo de entidade. O `name` e o `wallet_address` são sempre enviados, independentemente do que a lista diga. Um tipo de entidade que você nunca escolheu compartilha todos os campos. Uma lista vazia também é uma escolha: ela compartilha apenas o nome e a carteira. properties: individual: type: array items: type: string enum: - name - wallet_address - address - national_id - customer_identification - date_of_birth - place_of_birth description: Campos compartilhados sobre uma pessoa física. company: type: array items: type: string enum: - name - wallet_address - address - national_id - customer_identification description: Campos compartilhados sobre uma pessoa jurídica. TravelRuleMatchingRules: type: object description: >- Com que rigor cada campo dos dados da contraparte é comparado com o que você possui, por tipo de entidade. Um campo que você omitir mantém o padrão. `NONE` ignora a comparação, `STRICT` exige exatamente as mesmas palavras, `CONTAINS` aceita um valor cujas palavras aparecem todas no outro, `DEFAULT` é a correspondência padrão por subconjunto e `FUZZY` aceita grafias próximas (e, para datas de nascimento, dia e mês invertidos). properties: individual: type: object description: Regras para uma pessoa física. properties: name: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: 'Padrão: segue `name_matching_strictness`.' date_of_birth: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: Padrão `NONE`. address: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: Padrão `NONE`. account: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: A carteira pela qual a troca foi roteada. Padrão `STRICT`. company: type: object description: Regras para uma pessoa jurídica. properties: name: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: 'Padrão: segue `name_matching_strictness`.' address: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: Padrão `NONE`. account: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: A carteira pela qual a troca foi roteada. Padrão `STRICT`. TravelRuleNetworkState: type: object description: >- Como as mensagens da Travel Rule em uma rede seriam enviadas para esta aplicação e por que não podem ser. É o status da configuração, não uma verificação em tempo real de funcionamento ou de entrega. properties: rail: type: string enum: - GTR - TRUST - VERIFYVASP - SYGNA mode: type: string enum: - own - didit - 'off' - unavailable description: >- own: é usada a associação conectada da aplicação; didit: a associação da Didit inclui a aplicação como participante ativo próprio; off: roteamento pela plataforma desativado em disabled_networks, sem associação própria; unavailable: nada pode enviar por esta rede ainda (veja state e reason). state: type: string enum: - own_membership - live_through_didit - 'off' - didit_onboarding - questionnaire_needed - questionnaire_in_review - request_access - request_sent - unavailable - error description: >- own_membership: sua associação conectada envia; live_through_didit: seu próprio participante na associação da Didit envia; off: você desativou o roteamento pela plataforma; didit_onboarding: a associação da própria Didit nesta rede ainda não está ativa, então não pode atender ninguém; questionnaire_needed / questionnaire_in_review: o questionário de due diligence precisa ser enviado ou está com a Didit; request_access: o questionário foi aprovado, solicite a rede; request_sent: seu participante está passando pelo onboarding; unavailable: veja reason; error: veja reason. reason: type: string enum: - own_membership_connected - platform_network_switched_off - own_membership_only - sandbox_application - didit_membership_not_live - participant_suspended - participant_rejected - questionnaire_not_submitted - questionnaire_submitted - questionnaire_changes_requested - questionnaire_rejected - participant_not_requested - participant_active - participant_key_missing - participant_key_unresolved - provisioning_failed - questionnaire_pending - submitted_to_network description: >- Detalhe legível por máquina do estado. own_membership_only: a Didit não registra aplicações nesta rede (TRUST), conecte sua própria associação; sandbox_application: transferências de sandbox nunca chegam a uma rede; provisioning_failed: a rede recusou o registro, o last_error do participante informa o motivo e solicitar a rede novamente faz uma nova tentativa. platform_available: type: boolean description: >- Indica se a associação da própria Didit a esta rede está configurada; não é uma verificação de integridade em tempo real. connected: type: boolean description: >- Indica se existe uma associação de cliente conectada. As credenciais são validadas localmente; a validação na rede ocorre em uma troca real. participant: $ref: '#/components/schemas/TravelRuleNetworkParticipantSummary' vasps_reachable: type: integer description: VASPs do diretório acessíveis nesta rede. routed_30d: type: integer description: >- As transferências desta aplicação realizadas nesta rede nos últimos 30 dias. TravelRuleNetworkParticipantSummary: type: object nullable: true description: >- O participante próprio desta aplicação na rede, ou null quando não houver. properties: mode: type: string enum: - platform - own description: >- platform: operado pela associação da Didit; own: com onboarding feito sob a associação própria da aplicação. status: type: string enum: - not_requested - questionnaire_pending - submitted_to_network - active - suspended - rejected description: >- not_requested: nunca solicitado, ou a rede recusou a primeira requisição (veja last_error); questionnaire_pending: aguardando a aprovação do questionário de due diligence; submitted_to_network: encaminhado ao onboarding da rede; active: a rede atribuiu a esta aplicação seu próprio código de participante; suspended / rejected: a Didit suspendeu ou rejeitou. participant_code: type: string description: >- O código que a rede atribuiu a esta aplicação (no GTR, o código VASP dela). As mensagens enviadas levam este código, nunca o da própria Didit. requested_at: type: string format: date-time nullable: true activated_at: type: string format: date-time nullable: true last_error: type: string description: >- A resposta da rede quando ela recusou o registro; vazio nos demais casos. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.