> ## 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 de diretório - API Travel Rule > Na Didit, use a API Claim a Directory Entry para reivindicar a entrada de diretório que corresponde a este espaço de trabalho. Prompt da API para reivindicar uma entrada de 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/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 correspondente a este espaço de trabalho. Quando o e-mail profissional pertence a um domínio listado na entrada, a reivindicação é comprovada e aplica-se de imediato: o perfil do VASP e as definições da Travel Rule são preenchidos a partir da entrada e a Travel Rule é ativada, pelo que a transferência seguinte para essa entidade é encaminhada através da rede 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: A área de trabalho com o respetivo estado da 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 aderiu de forma gratuita, pelo que não tem uma área de trabalho gratuita. 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 correspondente a este espaço de trabalho. Obtenha os IDs a partir de `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 de 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: >- A receção de dados da Travel Rule é gratuita. O envio só é faturado após a faturação ser ativada. billing_enabled_at: type: string format: date-time nullable: true didit_network: type: object description: >- Se a rede Didit lista este VASP e, caso contrário, cada condição que ainda lhe falta. settings: $ref: '#/components/schemas/TravelRuleSettingsDetail' TravelRuleWorkspaceTxtRecord: type: object description: >- O registo TXT a publicar para a prova de DNS. Vazio até que uma prova tenha sido iniciada. properties: host: type: string example: didit-tr-verify.example.com value: type: string TravelRuleSettingsDetail: type: object properties: is_enabled: type: boolean description: >- Indica se o fluxo de negociação gerida de Travel Rule está ativo para transações de saída `travelRule` nesta aplicação. jurisdiction: type: string maxLength: 8 description: >- O código de jurisdição operacional do seu VASP. Predefinição `"EU"`. A Didit mapeia-o para o regime que estampa nas suas transações de Travel Rule como `travel_rule_regime` (por exemplo, `EU` ou o código de um Estado-membro da UE passa a `eu`), que as regras de transação podem utilizar como chave. Outros clientes da Didit veem-no como a sua jurisdição no diretório de VASPs assim que a rede Didit listar o seu perfil. name_matching_strictness: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: >- Com que rigor os nomes dos beneficiários têm de coincidir antes de uma transferência poder atingir o estado COMPLETED. `CONTAINS` aceita um nome cujas palavras apareçam todas no outro. confirmation_timeout_hours: type: integer minimum: 1 description: >- Horas que uma transferência AWAITING_COUNTERPARTY pode permanecer por confirmar antes de o processo periódico de limpeza a expirar. Predefinição: 48. timeout_outcome: type: string enum: - HOLD - REJECT - PROCEED description: >- O que acontece à transação subjacente quando uma transferência expira. Predefiniçã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 predefinida da sua aplicação. Montante mínimo de transferência que aciona uma partilha gerida; transferências abaixo dele resolvem diretamente para NOT_APPLICABLE. A Didit compara o montante da transação convertido para a sua moeda predefinida, ou o `amount_in_default_currency` enviado; quando nenhum montante convertido estiver disponível, o limiar não se aplica. O valor predefinido é "0.00" (o TFR da UE não aplica montante mínimo). ownership_validation_mode: type: string enum: - FULL - SIMPLIFIED - AUTOMATED description: >- Quanto comprovativo é necessário para comprovar a propriedade de uma carteira. `FULL` exige sempre um comprovativo (mensagem assinada, depósito de teste ou captura de ecrã revista), nunca a palavra do utilizador final. `SIMPLIFIED` aceita uma autodeclaração abaixo de `simplified_validation_threshold` e um comprovativo acima dele. `AUTOMATED` permite que o livro de endereços e comprovativos anteriores respondam por si próprios, incluindo autodeclarações enquanto `allow_self_declaration` for verdadeiro. Predefinição: `AUTOMATED`. simplified_validation_threshold: type: string description: >- String decimal, por predefinição "0.00". No modo `SIMPLIFIED`, uma transferência abaixo deste montante (na moeda do limiar) aceita uma autodeclaração. Uma transferência sem montante nessa moeda conta como estando acima dele. data_sharing_fields: $ref: '#/components/schemas/TravelRuleDataSharingFields' matching_rules: $ref: '#/components/schemas/TravelRuleMatchingRules' legal_name: type: string description: >- A denominação social do seu VASP. Obrigatória (não vazia) para definir is_enabled como true. lei: type: string description: >- O seu Identificador de Entidade Jurídica (LEI), apresentado no diretório de VASP. compliance_email: type: string format: email description: >- E-mail de contacto de conformidade para o seu perfil de VASP. A rede Didit lista o seu perfil apenas após este endereço ser confirmado através de uma ligação enviada por e-mail (POST /v3/travel-rule/settings/compliance-email/confirmation/); a sua alteração requer 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 Didit e contactado na via INTERNAL. A listagem também requer uma aplicação de produção, o Travel Rule ativo, uma denominação social e um e-mail de conformidade confirmado; didit_network indica quais estão em falta. O valor predefinido é true. inbound_auto_accept: type: boolean description: >- Quando for true, um inquérito TRP de entrada cuja carteira do beneficiário seja uma entrada verificada no livro de endereços com um nome correspondente é aprovado automaticamente. Quando for false, esse inquérito aguarda em ON_HOLD que o aprove ou recuse com o endpoint de propriedade. As transferências pela via INTERNAL e após depósito não são afetadas. O padrão é true. allow_self_declaration: type: boolean description: >- Quando for true, o widget de propriedade da carteira disponibiliza a autodeclaração como método de prova alternativo. O valor predefinido é true. allow_screenshot_proof: type: boolean description: >- Quando for true, o widget de propriedade da carteira disponibiliza o carregamento de capturas de ecrã como método de prova de propriedade. O padrão é true. auto_wallet_verification: type: boolean description: >- Quando for true, a submissão de uma transferência da Travel Rule de saída que necessite de comprovativo de controlo da carteira por parte do utilizador final gera automaticamente uma sessão do widget de propriedade da carteira vinculada à transação e expõe-na no bloco action_required da transação. O padrão é true. vasp_attribution_enabled: type: boolean description: >- Quando for true, uma transferência da Travel Rule de saída que nenhuma via consiga encaminhar é atribuída através de análise de blockchain: a carteira de destino é associada ao respetivo VASP proprietário, a entidade é registada na transferência e no diretório de VASP, e as vias são executadas novamente uma vez com o nome atribuído. O padrão é true. counterparty_screening_enabled: type: boolean description: >- Triagem opcional de sanções e notícias adversas de VASPs de contraparte, faturada por triagem ao preço da Triagem AML da empresa. Quando ativada, a Didit analisa a contraparte que uma exchange de saída alcança (reutilizando uma triagem com menos de 30 dias) e pode analisar uma com POST /v3/travel-rule/vasps/{vasp_id}/screening/. Predefinição false: nada é analisado ou faturado. sunrise_policy: type: string enum: - '' - HOLD - REJECT - PROCEED description: >- O impacto que uma transferência expirada tem na sua transação quando a contraparte é uma entrada do diretório numa jurisdição em sunrise_jurisdictions, que ainda não aplica a Travel Rule: HOLD move-a para análise, REJECT recusa-a, PROCEED mantém o seu estado inalterado. Vazio (a predefinição) segue timeout_outcome. Aplica-se antes de non_responsive_policy. sunrise_jurisdictions: type: array items: type: string readOnly: true description: >- Apenas de leitura. Os países (ISO 3166 alfa-2) que a Didit trata como estando num período de transição da Travel Rule, onde sunrise_policy se aplica. Atualmente CO, KH e VN. Qualquer outra jurisdição, bem como uma vazia ou desconhecida, segue timeout_outcome. non_responsive_policy: type: string enum: - '' - HOLD - REJECT - PROCEED description: >- O impacto que uma transferência expirada tem na sua transação quando a contraparte é uma entrada do diretório cuja capacidade de resposta é UNRESPONSIVE: HOLD, REJECT ou PROCEED, tal como em timeout_outcome. Vazio (a predefinição) segue timeout_outcome. sunrise_policy aplica-se primeiro quando ambas forem aplicáveis. travel_address: type: string description: >- Apenas de leitura. O Travel Address próprio do seu VASP - o endpoint codificado de consulta TRP de entrada que outros VASP utilizam para entrar em contacto consigo. Vazio enquanto `is_enabled` for false. disabled_networks: type: array items: type: string enum: - GTR - TRUST - VERIFYVASP - SYGNA description: >- Redes que optaram por não aderir à plataforma. Não desativa as suas adesões próprias associadas nem disponibiliza redes indisponíveis. default: [] networks: type: object readOnly: true description: >- Por rede, como esta aplicação enviaria e por que motivo não o consegue fazer. Nenhuma rede, incluindo a GTR, está incluída por predefinição: uma rede fica acessível através da sua própria adesão ligada, ou através da adesão da Didit assim que a adesão da Didit a essa rede estiver ativa e o seu próprio participante nela estiver ativo. Não se trata de uma verificação de estado ou de entrega em tempo real. 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: >- Indica se a rede Didit lista o seu perfil de VASP, para que outros clientes Didit o encontrem no diretório e o contactem pela via INTERNAL, bem como cada condição que ainda falta cumprir. 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 a ligação enviada por e-mail. excluded_by_staff: a Didit marcou a aplicação como de teste, demonstração ou interna. compliance_email_confirmed: type: boolean description: >- Indica se o compliance_email atual foi confirmado através da ligação enviada por e-mail. TravelRuleDataSharingFields: type: object description: >- Os campos que a Didit envia para o VASP contraparte sobre os seus próprios utilizadores, por tipo de entidade. O `name` e o `wallet_address` são sempre enviados, independentemente do que a lista indicar. Um tipo de entidade que nunca escolheu partilha todos os campos. Uma lista vazia também é uma escolha: partilha 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 partilhados relativos a uma pessoa singular. company: type: array items: type: string enum: - name - wallet_address - address - national_id - customer_identification description: Campos partilhados relativos a uma pessoa coletiva. TravelRuleMatchingRules: type: object description: >- Com que rigor cada campo dos dados da contraparte é comparado com o que possui, por tipo de entidade. Um campo omitido mantém a sua predefinição. `NONE` ignora a comparação, `STRICT` exige exatamente as mesmas palavras, `CONTAINS` aceita um valor cujas palavras apareçam todas no outro, `DEFAULT` é a correspondência de subconjunto padrão e `FUZZY` aceita grafias aproximadas (e, para datas de nascimento, dia e mês trocados). properties: individual: type: object description: Regras para uma pessoa singular. properties: name: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: 'Predefinição: segue `name_matching_strictness`.' date_of_birth: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: Predefinição `NONE`. address: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: Predefinição `NONE`. account: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: >- A carteira através da qual a exchange foi encaminhada. Predefinição `STRICT`. company: type: object description: Regras para uma pessoa coletiva. properties: name: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: 'Predefinição: segue `name_matching_strictness`.' address: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: Predefinição `NONE`. account: type: string enum: - NONE - STRICT - CONTAINS - DEFAULT - FUZZY description: >- A carteira através da qual a exchange foi encaminhada. Predefinição `STRICT`. TravelRuleNetworkState: type: object description: >- Como as mensagens da Travel Rule numa rede seriam enviadas para esta aplicação, e porque não podem sê-lo. Estado de configuração, não uma verificação de estado ou de entrega em direto. properties: rail: type: string enum: - GTR - TRUST - VERIFYVASP - SYGNA mode: type: string enum: - own - didit - 'off' - unavailable description: >- own: é utilizada a adesão associada da aplicação; didit: a adesão da Didit regista a aplicação como o seu próprio participante ativo; off: encaminhamento da plataforma desativado em disabled_networks sem adesão própria; unavailable: ainda nada pode enviar nesta rede (consulte 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: a sua adesão associada envia; live_through_didit: o seu próprio participante na adesão da Didit envia; off: desativou o encaminhamento da plataforma; didit_onboarding: a adesão própria da Didit a esta rede ainda não está ativa, pelo que não pode transportar ninguém; questionnaire_needed / questionnaire_in_review: o questionário de diligência devida tem de ser submetido ou está com a Didit; request_access: o questionário está aprovado, solicite acesso à rede; request_sent: o seu participante está a passar pelo processo de onboarding; unavailable: consulte reason; error: consulte 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 do estado legível por máquina. own_membership_only: a Didit não suporta aplicações nesta rede (TRUST), associe a sua própria adesão; sandbox_application: as transferências em sandbox nunca chegam a uma rede; provisioning_failed: a rede recusou o registo, o last_error do participante indica o motivo e voltar a pedir à rede tenta novamente. platform_available: type: boolean description: >- Se a adesão da própria Didit a esta rede está configurada; não é uma verificação de estado em tempo real. connected: type: boolean description: >- Se existe uma adesão de cliente ligada. As credenciais são validadas localmente; a validação de rede ocorre numa troca em direto. 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 efetuadas 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 tiver nenhum. properties: mode: type: string enum: - platform - own description: >- platform: transportado pela adesão da Didit; own: integrado sob a adesão própria da aplicação. status: type: string enum: - not_requested - questionnaire_pending - submitted_to_network - active - suspended - rejected description: >- not_requested: nunca foi pedido, ou a rede recusou o primeiro pedido (consulte last_error); questionnaire_pending: a aguardar que o questionário de diligência devida seja aprovado; submitted_to_network: entregue ao onboarding da rede; active: a rede atribuiu a esta aplicação o seu próprio código de participante; suspended / rejected: a Didit suspendeu-a ou rejeitou-a. participant_code: type: string description: >- O código que a rede atribuiu a esta aplicação (para a GTR, o seu código de VASP). As mensagens enviadas contêm este código, nunca o da 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 recusou o registo; vazia nos restantes casos. 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.