> ## 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.

# Responder à recolha por e-mail (API): Travel Rule

> Aceite ou recuse uma troca Travel Rule com a Didit através de uma ligação de e-mail única, indicando o nome do beneficiário.



Responder ao prompt da API Email Pickup
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Accept or decline a pending Travel Rule exchange from a one-time email pickup link - the counterparty-facing side of Didit's EMAIL fallback rail.

Endpoint:
POST https://verification.didit.me/v3/travel-rule/pickup/{token}/respond/

Authentication:
None - the one-time link token is the credential.

Request body (application/json):
\{"decision": "accept", "beneficiary_name": "Carlos Ruiz"}
or
\{"decision": "decline", "decline_reason": "not_our_customer"}

Optional fields:
\- ivms_response - your full IVMS 101 response (up to 16384 characters); its beneficiary name wins over beneficiary_name.
\- beneficiary_name - up to 255 characters.
\- decline_reason - data_mismatch | not_our_customer | wallet_not_hosted | sanctions | risk_appetite | jurisdiction | insufficient_data | other, or empty (the default) for no reason.
\- decline_detail - up to 512 characters; required when decision is decline and decline_reason is other.
\- contact - the contact the link was sent to, as a UUID; when the body leaves it out, the contact query parameter (the link's ?contact= value) is used.

Behavior:
\- accept - the beneficiary name is run through the originator's name rule: the transfer moves to COMPLETED on a match, COUNTERPARTY_MISMATCHED_DATA otherwise. Supply the name exactly as your records hold it. The response is {"status": "..."}.
\- decline - the transfer moves to COUNTERPARTY_VASP_GENERAL_DECLINE, and the sender's timeline records the reason. The response is {"status": "COUNTERPARTY_VASP_GENERAL_DECLINE", "decline_reason": "..."}.
\- You can answer once: afterwards both pickup endpoints return 410.

Failure modes:
\- 404 - unknown token.
\- 410 - the window closed: the counterparty already answered, the transfer left AWAITING_COUNTERPARTY, or the pickup deadline passed.
\- 400 - decision is missing or is not accept or decline, decline_detail is missing for a decline with reason other, ivms_response is not an IVMS 101 object or is too long, or a contact in the body is not a UUID ({"contact": ["Must be a valid UUID."]}).

Counterparty integration guide: /transaction-monitoring/travel-rule-interoperability#email-pickup.`

\</pre>



      
      

Colar em



## OpenAPI

````yaml pt/openapi-25.json POST /v3/travel-rule/pickup/{token}/respond/
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/pickup/{token}/respond/:
    post:
      tags:
        - Travel Rule
      summary: Responder a uma recolha por via de e-mail
      description: >-
        Público, não autenticado. Aceita ou recusa a troca a partir da ligação
        de recolha enviada por e-mail. Ao aceitar, beneficiary_name é verificado
        contra a política name_matching_strictness do ordenante.
      operationId: respondTravelRulePickup
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
        - name: contact
          in: query
          required: false
          schema:
            type: string
          description: >-
            O valor `?contact=` da ligação. Utilizado quando o corpo não envia
            nenhum `contact`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TravelRulePickupRespondRequest'
            example:
              decision: accept
              beneficiary_name: Carlos Ruiz
      responses:
        '200':
          description: >-
            O estado da troca resultante: COMPLETED ou
            COUNTERPARTY_MISMATCHED_DATA após uma aceitação,
            COUNTERPARTY_VASP_GENERAL_DECLINE após uma recusa, que também
            devolve `decline_reason`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  decline_reason:
                    type: string
                    description: Presente após uma recusa.
              examples:
                accepted:
                  value:
                    status: COMPLETED
                declined:
                  value:
                    status: COUNTERPARTY_VASP_GENERAL_DECLINE
                    decline_reason: not_our_customer
        '400':
          description: >-
            Um campo é inválido: por exemplo, `decision` em falta ou diferente
            de `accept` ou `decline`, `decline_detail` em falta numa recusa com
            `decline_reason: other`, uma `ivms_response` que não seja um objeto
            IVMS 101 ou tenha mais de 16384 carateres, ou um `contact` no corpo
            que não seja um UUID (`{"contact": ["Must be a valid UUID."]}`).
          content:
            application/json:
              example:
                decline_detail:
                  - Say what the reason is when you choose another reason.
        '404':
          description: Token desconhecido.
        '410':
          description: >-
            A janela foi encerrada: a contraparte já respondeu, a transferência
            saiu de AWAITING_COUNTERPARTY ou o prazo expirou.
      security:
        - {}
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            https://verification.didit.me/v3/travel-rule/pickup/{token}/respond/
            \
              -H 'Content-Type: application/json' \
              -d '{"decision": "accept", "beneficiary_name": "Carlos Ruiz"}'
components:
  schemas:
    TravelRulePickupRespondRequest:
      type: object
      required:
        - decision
      properties:
        decision:
          type: string
          enum:
            - accept
            - decline
        beneficiary_name:
          type: string
          description: >-
            O nome do beneficiário conforme consta dos seus registos, processado
            pela regra de nomes do VASP remetente. `ivms_response` tem
            precedência quando indica o beneficiário.
          maxLength: 255
        decline_reason:
          type: string
          enum:
            - ''
            - data_mismatch
            - not_our_customer
            - wallet_not_hosted
            - sanctions
            - risk_appetite
            - jurisdiction
            - insufficient_data
            - other
          description: >-
            O motivo da sua recusa. Registado na cronologia de transferências do
            VASP remetente. Vazio (o padrão) quando não indicar nenhum motivo.
        decline_detail:
          type: string
          maxLength: 512
          description: >-
            Texto livre; obrigatório quando `decision` é `decline` e
            `decline_reason` é `other`.
        ivms_response:
          type: object
          description: >-
            A sua resposta IVMS 101 completa. O respetivo nome do beneficiário
            tem precedência sobre `beneficiary_name`.
        contact:
          type: string
          format: uuid
          description: >-
            O contacto para o qual a ligação foi enviada, a partir do valor
            `?contact=` da ligação. Quando o corpo o omite, é utilizado o
            parâmetro de consulta `contact`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.