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

# Obtenir configuració Travel Rule API: perfil VASP

> Consulta la configuració Travel Rule de Didit: perfil VASP, política de negociació, mètodes de prova, modes de xarxa i Travel Address.



Prompt de l'API per obtenir la configuració de Travel Rule
        Copia el prompt al porta-retalls



      
      

\<pre>

\`Read the application's Travel Rule configuration and VASP profile.

Endpoint:
GET https://verification.didit.me/v3/travel-rule/settings/

Authentication:
Use the x-api-key header with my Didit API key.

What to read from the response:
\- is_enabled - whether the managed exchange runs for outbound travelRule transactions.
\- legal_name, lei, jurisdiction, compliance_email, is_discoverable - the VASP profile shown to counterparties and the directory.
\- name_matching_strictness (NONE | STRICT | DEFAULT | FUZZY), confirmation_timeout_hours, timeout_outcome (HOLD | REJECT | PROCEED), threshold_amount, inbound_auto_accept - the negotiation policy.
\- threshold_amount is compared with the amount converted to the application's default currency (or the amount_in_default_currency you send); a transfer whose amount cannot be converted stays in scope, and "0.00" puts every transfer in scope.
Sandbox applications never convert the amount, so there the threshold applies only when the request sends amount_in_default_currency.
\- inbound_auto_accept defaults to true.
\- allow_self_declaration, allow_screenshot_proof, auto_wallet_verification, vasp_attribution_enabled - proof-method and automation toggles (all default to true).
\- counterparty_screening_enabled - opt-in sanctions and adverse-media screening of counterparty VASPs, billed per screening at the Company AML Screening price (default false: nothing is screened or billed).
\- sunrise_policy, non_responsive_policy - HOLD | REJECT | PROCEED, or empty to follow timeout_outcome: what an expired transfer does to its transaction when the counterparty is a directory entry in a jurisdiction listed in sunrise_jurisdictions, or a directory entry whose responsiveness is UNRESPONSIVE.
The sunrise policy applies first, then the non-responsive policy, then timeout_outcome.
\- sunrise_jurisdictions - read-only; the countries Didit treats as in a Travel Rule sunrise period (currently CO, KH and VN).
Any other jurisdiction follows timeout_outcome.
\- disabled_networks - network rails (GTR | TRUST | VERIFYVASP | SYGNA) opted out of Didit's platform membership.
It only affects platform membership, which Didit does not offer on any network yet.
\- Didit has no platform membership on any network today (Didit is onboarding as a provider), so a network rail routes only through your own membership connected in Marketplace.
Enabling Travel Rule does not change network availability.
\- networks - read-only per-network status keyed by gtr/trust/verifyvasp/sygna: {rail, mode, state, reason, platform_available, connected, participant} where mode is own | didit | off | unavailable.
Production does not report didit yet: every network reads unavailable (state didit_onboarding) unless you connected your own membership (own) or disabled it (off).
GET /v3/travel-rule/networks/ returns the same states with the questionnaire and participants.
\- With your own membership, Didit reads the counterparty's answer over GTR, VerifyVASP and Sygna from the network's response or by polling it every 5 minutes. TRUST only sends: a transfer sent over it stays AWAITING_COUNTERPARTY until it expires (then timeout_outcome applies).
If the message cannot be delivered, the transfer moves to COUNTERPARTY_VASP_NOT_REACHABLE instead.
\- travel_address - read-only; your VASP's own encoded TRP inquiry address, for example "ta2ih1MicegQ3JqiKz9xT89KsSuwaDJYw8DgzmeS5uNDp3dGW3bweBWLKws442chRsyNxmmJnyWc7frxjjSeABVsYR11UuBePkw6E".
It is empty until Travel Rule is enabled (is_enabled: true).
Share it with counterparties so they can reach you machine-to-machine.
\- didit_network - read-only {listed, missing[], compliance_email_confirmed}: whether the Didit network lists your profile, so other Didit customers find it and reach you on the INTERNAL rail, and each condition still unmet (travel_rule_off, sandbox_application, not_discoverable, legal_name_missing, compliance_email_missing, compliance_email_unconfirmed, excluded_by_staff, internal_organization).
Confirm the compliance email with POST /v3/travel-rule/settings/compliance-email/confirmation/.

Update with PUT /v3/travel-rule/settings/ (partial update - send only the fields to change).

Full guide: /transaction-monitoring/travel-rule#setup.`

\</pre>



      
      

Enganxa a

## Disponibilitat de xarxesGTR, TRUST, VerifyVASP i Sygna requereixen una membresia activa.
Avui Didit no té cap membresia de plataforma en cap d'aquestes xarxes; Didit s'està incorporant com a proveïdor.
Fins llavors, un canal de xarxa només encamina a través de la teva pròpia membresia, connectada a **Marketplace**.
Llegeix `networks` per a l'aplicació que configures:- **`own`** - La teva membresia connectada té prioritat, fins i tot si la xarxa és a `disabled_networks`. Els intercanvis utilitzen la teva identitat de xarxa.
- **`didit`** - La membresia de Didit fa que la teva aplicació sigui el seu propi participant actiu en aquesta xarxa, amb el codi que la xarxa t'ha assignat.
  Per a aquesta xarxa no calen credencials de membresia de client.
  Per arribar-hi cal el qüestionari de xarxa de Didit i una sol·licitud a la xarxa: consulta [Obtenir les xarxes de Travel Rule](https://docs.didit.me/ca/management-api/travel-rule/get-networks.md).
  Producció encara no informa d'aquest mode, perquè la membresia pròpia de Didit no està activa.
- **`off`** - Has desactivat l'encaminament de la plataforma i no tens cap membresia pròpia connectada. Elimina la xarxa de `disabled_networks` per permetre l'encaminament de la plataforma quan estigui disponible, o connecta la teva pròpia membresia.
- **`unavailable`** - Ara mateix res no pot enviar en aquesta xarxa per a la teva aplicació.
  `state` i `reason` indiquen el motiu: per exemple `didit_onboarding` mentre la membresia pròpia de Didit a la xarxa no estigui activa, o `questionnaire_needed` abans que s'aprovi el teu qüestionari.
  Avui totes les xarxes informen d'aquest mode, tret que hagis connectat la teva pròpia membresia o hagis desactivat la xarxa.
  Connecta la teva pròpia membresia a **Marketplace**, o utilitza una contrapart `INTERNAL`, `TRP` o `EMAIL` accessible.`disabled_networks` només afecta la membresia de plataforma de Didit, que encara no està disponible, de manera que avui no té cap efecte en l'encaminament.S'escull un canal de xarxa quan `beneficiary_data` de la transferència porta l'identificador de la contrapart en aquella xarxa (per exemple `counterparty_gtr_vasp_code` o `counterparty_trust_membership_id`), o quan l'[entrada del directori](https://docs.didit.me/ca/transaction-monitoring/travel-rule.md#rutes) de la contrapart la llista amb un codi d'aquella xarxa.Sobre GTR, VerifyVASP i Sygna, Didit llegeix la resposta de la contrapart a partir de la resposta de la xarxa o consultant la xarxa cada 5 minuts, i la transferència passa a `COMPLETED`, `COUNTERPARTY_MISMATCHED_DATA` o `COUNTERPARTY_VASP_GENERAL_DECLINE`.
TRUST només permet l'enviament: una transferència enviada per aquest canal es queda a `AWAITING_COUNTERPARTY` fins que transcorri el període indicat per `confirmation_timeout_hours` i passi a `EXPIRED`, i aleshores s'aplica `timeout_outcome`.
Si el missatge no es pot lliurar, la transferència passa a `COUNTERPARTY_VASP_NOT_REACHABLE`.
Consulta [Xarxes de Travel Rule](https://docs.didit.me/ca/transaction-monitoring/travel-rule-networks.md) per saber què abasta cada xarxa avui.`platform_available` és un estat de configuració, no una comprovació en directe de l'estat de la xarxa. `connected` indica que una membresia desada ha superat la validació local de credencials, no que l'intercanvi amb el proveïdor hagi funcionat. Activar `is_enabled` o buidar `disabled_networks` no pot aprovisionar una membresia que falti.Per a les comprovacions que pots fer sense credencials de xarxa, consulta [Proves sense credencials de xarxa](https://docs.didit.me/ca/transaction-monitoring/travel-rule.md#prova-sense-credencials-de-xarxa).


## OpenAPI

````yaml ca/openapi-25.json GET /v3/travel-rule/settings/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/travel-rule/settings/:
    get:
      tags:
        - Travel Rule
      summary: Obtenir la configuració de Travel Rule
      description: >-
        Llegeix la configuració de Travel Rule i el perfil de VASP de
        l'aplicació. Crea automàticament una fila de configuració per defecte
        (desactivada) i un perfil buit en la primera lectura.
      operationId: getTravelRuleSettings
      responses:
        '200':
          description: Configuració actual de Travel Rule i perfil de VASP.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelRuleSettingsDetail'
              examples:
                Disabled (default):
                  value:
                    is_enabled: false
                    jurisdiction: EU
                    name_matching_strictness: DEFAULT
                    confirmation_timeout_hours: 48
                    timeout_outcome: HOLD
                    threshold_amount: '0.00'
                    inbound_auto_accept: true
                    allow_self_declaration: true
                    allow_screenshot_proof: true
                    auto_wallet_verification: true
                    vasp_attribution_enabled: true
                    legal_name: ''
                    lei: ''
                    compliance_email: ''
                    is_discoverable: true
                    counterparty_screening_enabled: false
                    sunrise_policy: ''
                    sunrise_jurisdictions:
                      - CO
                      - KH
                      - VN
                    non_responsive_policy: ''
                    travel_address: ''
                    disabled_networks: []
                    networks:
                      gtr:
                        rail: GTR
                        mode: unavailable
                        state: didit_onboarding
                        reason: didit_membership_not_live
                        platform_available: false
                        connected: false
                        participant: null
                        vasps_reachable: 0
                        routed_30d: 0
                      trust:
                        rail: TRUST
                        mode: unavailable
                        state: unavailable
                        reason: own_membership_only
                        platform_available: false
                        connected: false
                        participant: null
                        vasps_reachable: 0
                        routed_30d: 0
                      verifyvasp:
                        rail: VERIFYVASP
                        mode: unavailable
                        state: didit_onboarding
                        reason: didit_membership_not_live
                        platform_available: false
                        connected: false
                        participant: null
                        vasps_reachable: 0
                        routed_30d: 0
                      sygna:
                        rail: SYGNA
                        mode: unavailable
                        state: didit_onboarding
                        reason: didit_membership_not_live
                        platform_available: false
                        connected: false
                        participant: null
                        vasps_reachable: 0
                        routed_30d: 0
                    didit_network:
                      listed: false
                      missing:
                        - travel_rule_off
                        - legal_name_missing
                        - compliance_email_missing
                      compliance_email_confirmed: false
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X GET https://verification.didit.me/v3/travel-rule/settings/ \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.travel_rule.retrieve_settings()
            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.retrieveSettings();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.TravelRule.RetrieveSettings(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.travelRule().retrieveSettings();
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->travelRule->retrieveSettings();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.travel_rule.retrieve_settings
            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.RetrieveSettingsAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    TravelRuleSettingsDetail:
      type: object
      properties:
        is_enabled:
          type: boolean
          description: >-
            Indica si el flux gestionat de negociació de Travel Rule està actiu
            per a transaccions `travelRule` sortints en aquesta aplicació.
        jurisdiction:
          type: string
          maxLength: 8
          description: >-
            El codi de jurisdicció operativa del teu VASP. Per defecte `"EU"`.
            Didit l'assigna al règim que estampa a les teves transaccions de
            Travel Rule com a `travel_rule_regime` (per exemple, `EU` o el codi
            d'un estat membre de la UE es converteix en `eu`), sobre el qual es
            poden basar les regles de transacció. Altres clients de Didit el
            veuen com la teva jurisdicció al directori de VASP un cop la xarxa
            de Didit llista el teu perfil.
        name_matching_strictness:
          type: string
          enum:
            - NONE
            - STRICT
            - CONTAINS
            - DEFAULT
            - FUZZY
          description: >-
            Amb quin grau d'estrictesa han de coincidir els noms dels
            beneficiaris abans que una transferència pugui arribar a l'estat
            COMPLETED. `CONTAINS` accepta un nom les paraules del qual apareguin
            totes en l'altre.
        confirmation_timeout_hours:
          type: integer
          minimum: 1
          description: >-
            Hores que una transferència AWAITING_COUNTERPARTY pot romandre sense
            confirmar abans que el procés de neteja periòdic la faci caducar.
            Per defecte, 48.
        timeout_outcome:
          type: string
          enum:
            - HOLD
            - REJECT
            - PROCEED
          description: >-
            Què passa amb la transacció subjacent quan caduca una transferència.
            Per defecte HOLD. sunrise_policy i non_responsive_policy tenen
            prioritat quan s'apliquen i estan configurades.
        threshold_amount:
          type: string
          description: >-
            Cadena decimal, en la moneda predeterminada de la teva aplicació.
            Import mínim de transferència que activa un intercanvi gestionat;
            les transferències per sota d'aquest es resolen directament com a
            NOT_APPLICABLE. Didit compara l'import de la transacció convertit a
            la teva moneda predeterminada, o el camp
            `amount_in_default_currency` que enviïs; quan no hi ha cap import
            convertit disponible, el llindar no s'aplica. El valor per defecte
            és "0.00" (el TFR de la UE no aplica cap import mínim).
        ownership_validation_mode:
          type: string
          enum:
            - FULL
            - SIMPLIFIED
            - AUTOMATED
          description: >-
            Quanta prova requereix la titularitat d'una cartera. `FULL`
            requereix sempre una prova (missatge signat, dipòsit de prova o
            captura de pantalla revisada), mai la paraula de l'usuari final.
            `SIMPLIFIED` accepta una autodeclaració per sota de
            `simplified_validation_threshold` i una prova per sobre d'aquest
            llindar. `AUTOMATED` permet que la llibreta d'adreces i les proves
            anteriors responguin per si soles, incloses les autodeclaracions
            mentre `allow_self_declaration` sigui cert. Per defecte `AUTOMATED`.
        simplified_validation_threshold:
          type: string
          description: >-
            Cadena decimal, per defecte "0.00". En mode `SIMPLIFIED`, una
            transferència per sota d'aquest import (en la moneda del llindar)
            accepta una autodeclaració. Una transferència sense cap import en
            aquesta moneda es compta com a superior.
        data_sharing_fields:
          $ref: '#/components/schemas/TravelRuleDataSharingFields'
        matching_rules:
          $ref: '#/components/schemas/TravelRuleMatchingRules'
        legal_name:
          type: string
          description: >-
            La raó social del teu VASP. Obligatòria (no pot estar en blanc) per
            establir is_enabled a true.
        lei:
          type: string
          description: >-
            El teu identificador d'entitat jurídica, mostrat al directori de
            VASP.
        compliance_email:
          type: string
          format: email
          description: >-
            Correu electrònic de contacte de compliment per al teu perfil de
            VASP. La xarxa de Didit només llista el teu perfil un cop confirmada
            aquesta adreça mitjançant un enllaç enviat per correu electrònic
            (POST /v3/travel-rule/settings/compliance-email/confirmation/);
            modificar-la requereix una nova confirmació.
        is_discoverable:
          type: boolean
          description: >-
            Indica si el teu perfil de VASP es pot llistar a la xarxa de Didit:
            que altres clients de Didit poden trobar mitjançant GET
            /v3/travel-rule/vasps/ i accessible pel canal INTERNAL. Per a
            poder-lo llistar també cal una aplicació en producció, Travel Rule
            activat, una raó social i un correu electrònic de compliment
            confirmat; didit_network indica quins falten. Per defecte és true.
        inbound_auto_accept:
          type: boolean
          description: >-
            Quan és cert, una consulta TRP d'entrada la cartera beneficiària de
            la qual és una entrada verificada de la llibreta d'adreces amb un
            nom coincident s'aprova automàticament. Quan és fals, aquesta
            consulta s'espera en ON_HOLD que l'aprovis o la deneguis amb
            l'endpoint de titularitat. Les transferències de rail INTERNAL i
            posteriors al dipòsit no es veuen afectades. Per defecte cert.
        allow_self_declaration:
          type: boolean
          description: >-
            Quan és cert, el widget de titularitat de la cartera ofereix
            l'autodeclaració com a mètode de prova alternatiu. Per defecte cert.
        allow_screenshot_proof:
          type: boolean
          description: >-
            Quan és cert, el widget de titularitat de la cartera ofereix la
            càrrega de captures de pantalla com a mètode de prova de
            titularitat. Per defecte cert.
        auto_wallet_verification:
          type: boolean
          description: >-
            Quan és cert, enviar una transferència de sortida de la Travel Rule
            que requereix una prova de control de la cartera per part de
            l'usuari final crea automàticament una sessió del widget de
            titularitat de la cartera vinculada a la transacció i l'exposa al
            bloc action_required de la transacció. Per defecte cert.
        vasp_attribution_enabled:
          type: boolean
          description: >-
            Quan és cert, una transferència de sortida de la Travel Rule que cap
            rail pot encaminar s'atribueix mitjançant analítica de blockchain:
            la cartera de destinació es resol al seu VASP propietari, l'entitat
            es registra a la transferència i al directori de VASP, i els rails
            es tornen a executar una vegada amb el nom atribuït. Per defecte
            cert.
        counterparty_screening_enabled:
          type: boolean
          description: >-
            Cribratge opcional de sancions i mitjans adversos de VASP de les
            contraparts, facturat per cribratge al preu de Cribratge AML
            d'empreses. Quan està activat, Didit fa el cribratge de la
            contrapart a la qual arriba un intercanvi de sortida (reutilitzant
            un cribratge de menys de 30 dies) i pots fer-ne el cribratge d'una
            amb POST /v3/travel-rule/vasps/{vasp_id}/screening/. Per defecte
            false: no es fa cap cribratge ni es factura res.
        sunrise_policy:
          type: string
          enum:
            - ''
            - HOLD
            - REJECT
            - PROCEED
          description: >-
            Què fa una transferència caducada sobre la seva transacció quan la
            contrapart és una entrada del directori en una jurisdicció de
            sunrise_jurisdictions, que encara no aplica la Travel Rule: HOLD la
            passa a revisió, REJECT la rebutja, PROCEED deixa el seu estat
            intacte. En blanc (per defecte) segueix timeout_outcome. S'aplica
            abans de non_responsive_policy.
        sunrise_jurisdictions:
          type: array
          items:
            type: string
          readOnly: true
          description: >-
            Només de lectura. Els països (ISO 3166 alpha-2) que Didit considera
            en període d'entrada en vigor de la Travel Rule, on s'aplica
            sunrise_policy. Actualment CO, KH i VN. Qualsevol altra jurisdicció,
            així com una de buida o desconeguda, segueix timeout_outcome.
        non_responsive_policy:
          type: string
          enum:
            - ''
            - HOLD
            - REJECT
            - PROCEED
          description: >-
            Què fa una transferència caducada sobre la seva transacció quan la
            contrapart és una entrada del directori la capacitat de resposta de
            la qual és UNRESPONSIVE: HOLD, REJECT o PROCEED, igual que per a
            timeout_outcome. En blanc (per defecte) segueix timeout_outcome.
            sunrise_policy s'aplica primer quan es compleixen totes dues
            condicions.
        travel_address:
          type: string
          description: >-
            Només de lectura. La Travel Address pròpia del teu VASP: l'endpoint
            de consultes TRP entrants codificat que altres VASP utilitzen per
            contactar amb tu. Buit mentre `is_enabled` sigui false.
        disabled_networks:
          type: array
          items:
            type: string
            enum:
              - GTR
              - TRUST
              - VERIFYVASP
              - SYGNA
          description: >-
            Xarxes que han desactivat la pertinença a la plataforma. No
            inhabilita les teves pertinences pròpies connectades ni aprovisiona
            xarxes no disponibles.
          default: []
        networks:
          type: object
          readOnly: true
          description: >-
            Per xarxa, com enviaria aquesta aplicació i per què no pot fer-ho.
            Cap xarxa, inclosa GTR, s'inclou per defecte: es pot accedir a una
            xarxa mitjançant la teva pròpia pertinença connectada, o mitjançant
            la pertinença de Didit un cop la pertinença de Didit a aquesta xarxa
            estigui activa i el teu propi participant hi estigui actiu. No és
            una comprovació d'estat o de lliurament en directe.
          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 si la xarxa de Didit llista el teu perfil de VASP, de manera
            que altres clients de Didit el trobin al directori i hi puguin
            contactar a través de la via INTERNAL, així com cadascuna de les
            condicions que encara no compleix.
          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: >-
                Buit quan apareix a la llista. compliance_email_unconfirmed:
                envia la confirmació amb POST
                /v3/travel-rule/settings/compliance-email/confirmation/ i obre
                l'enllaç rebut per correu electrònic. excluded_by_staff: Didit
                ha marcat l'aplicació com a prova, demo o interna.
            compliance_email_confirmed:
              type: boolean
              description: >-
                Indica si l'actual compliance_email s'ha confirmat a través de
                l'enllaç enviat per correu electrònic.
    TravelRuleDataSharingFields:
      type: object
      description: >-
        Els camps que Didit envia al VASP de la contrapart sobre els teus propis
        usuaris, per tipus d'entitat. El `name` i la `wallet_address` s'envien
        sempre, digui el que digui la llista. Un tipus d'entitat que mai no
        hagis triat comparteix tots els camps. Una llista buida també és una
        opció: només comparteix el nom i la cartera.
      properties:
        individual:
          type: array
          items:
            type: string
            enum:
              - name
              - wallet_address
              - address
              - national_id
              - customer_identification
              - date_of_birth
              - place_of_birth
          description: Camps compartits sobre una persona física.
        company:
          type: array
          items:
            type: string
            enum:
              - name
              - wallet_address
              - address
              - national_id
              - customer_identification
          description: Camps compartits sobre una persona jurídica.
    TravelRuleMatchingRules:
      type: object
      description: >-
        Amb quin grau d'estrictesa es compara cada camp de les dades de la
        contrapart amb el que tens registrat, per tipus d'entitat. Un camp que
        ometis manté el seu valor per defecte. `NONE` omet la comparació,
        `STRICT` requereix exactament les mateixes paraules, `CONTAINS` accepta
        un valor les paraules del qual apareguin totes en l'altre, `DEFAULT` és
        la coincidència estàndard de subconjunt, i `FUZZY` accepta grafies
        properes (i, per a dates de naixement, dia i mes invertits).
      properties:
        individual:
          type: object
          description: Regles per a una persona física.
          properties:
            name:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: 'Per defecte: segueix `name_matching_strictness`.'
            date_of_birth:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: Per defecte `NONE`.
            address:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: Per defecte `NONE`.
            account:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: >-
                La cartera per on s'ha encaminat l'intercanvi. Per defecte
                `STRICT`.
        company:
          type: object
          description: Regles per a una persona jurídica.
          properties:
            name:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: 'Per defecte: segueix `name_matching_strictness`.'
            address:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: Per defecte `NONE`.
            account:
              type: string
              enum:
                - NONE
                - STRICT
                - CONTAINS
                - DEFAULT
                - FUZZY
              description: >-
                La cartera per on s'ha encaminat l'intercanvi. Per defecte
                `STRICT`.
    TravelRuleNetworkState:
      type: object
      description: >-
        Com s'enviarien els missatges de Travel Rule en una xarxa per a aquesta
        aplicació, i per què no es poden enviar. És un estat de configuració, no
        una comprovació d'estat o de lliurament en directe.
      properties:
        rail:
          type: string
          enum:
            - GTR
            - TRUST
            - VERIFYVASP
            - SYGNA
        mode:
          type: string
          enum:
            - own
            - didit
            - 'off'
            - unavailable
          description: >-
            own: s'utilitza la pertinença connectada de l'aplicació; didit: la
            pertinença de Didit inclou l'aplicació com a participant actiu
            propi; off: enrutament de plataforma desactivat a disabled_networks
            sense pertinença pròpia; unavailable: encara no es pot enviar res en
            aquesta xarxa (consulta state i 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: envia la teva pertinença connectada;
            live_through_didit: envia el teu propi participant a través de la
            pertinença de Didit; off: has desactivat l'enrutament de plataforma;
            didit_onboarding: la pertinença pròpia de Didit a aquesta xarxa
            encara no està activa, per la qual cosa no pot donar cabuda a ningú;
            questionnaire_needed / questionnaire_in_review: cal enviar el
            qüestionari de diligència deguda o està en revisió per part de
            Didit; request_access: el qüestionari està aprovat, sol·licita
            l'accés a la xarxa; request_sent: s'està tramitant l'alta del teu
            participant; unavailable: consulta reason; error: consulta 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: >-
            Detall de l'estat llegible per màquina. own_membership_only: Didit
            no gestiona aplicacions en aquesta xarxa (TRUST), connecta la teva
            pròpia pertinença; sandbox_application: les transferències de
            sandbox mai arriben a una xarxa; provisioning_failed: la xarxa ha
            rebutjat el registre, el camp last_error del participant n'indica el
            motiu i sol·licitar la xarxa de nou reintenta l'operació.
        platform_available:
          type: boolean
          description: >-
            Indica si la pertinença de Didit a aquesta xarxa està configurada;
            no és una comprovació de l'estat en temps real.
        connected:
          type: boolean
          description: >-
            Indica si existeix una pertinença de client connectada. Les
            credencials es validen localment; la validació de la xarxa es
            produeix en un intercanvi en temps real.
        participant:
          $ref: '#/components/schemas/TravelRuleNetworkParticipantSummary'
        vasps_reachable:
          type: integer
          description: VASP del directori accessibles en aquesta xarxa.
        routed_30d:
          type: integer
          description: >-
            Les transferències d'aquesta aplicació cursades en aquesta xarxa en
            els darrers 30 dies.
    TravelRuleNetworkParticipantSummary:
      type: object
      nullable: true
      description: >-
        El participant propi d'aquesta aplicació a la xarxa, o null si no en té
        cap.
      properties:
        mode:
          type: string
          enum:
            - platform
            - own
          description: >-
            platform: gestionat a través de la pertinença de Didit; own: alta
            tramitada sota la pertinença pròpia de l'aplicació.
        status:
          type: string
          enum:
            - not_requested
            - questionnaire_pending
            - submitted_to_network
            - active
            - suspended
            - rejected
          description: >-
            not_requested: mai sol·licitat, o la xarxa ha rebutjat la primera
            sol·licitud (consulta last_error); questionnaire_pending: pendent
            que s'aprovi el qüestionari de diligència deguda;
            submitted_to_network: enviat al procés d'alta de la xarxa; active:
            la xarxa ha assignat a aquesta aplicació el seu propi codi de
            participant; suspended / rejected: Didit l'ha suspès o rebutjat.
        participant_code:
          type: string
          description: >-
            El codi que la xarxa ha assignat a aquesta aplicació (per a GTR, el
            seu codi de VASP). Els missatges de sortida porten aquest codi, mai
            el de Didit.
        requested_at:
          type: string
          format: date-time
          nullable: true
        activated_at:
          type: string
          format: date-time
          nullable: true
        last_error:
          type: string
          description: >-
            La resposta de la xarxa quan ha rebutjat el registre; buida en cas
            contrari.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

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