> ## 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 credencials de l'API: client_id i clau d'API

> Obtén el client_id i la clau d'API de la teva aplicació Didit. Usa-la com a capçalera x-api-key en totes les crides. Sense contractes.



Indicació per obtenir les credencials de l'aplicació
        Copia el prompt al porta-retalls



      
      

\<pre>

\`Read one application's full record — including its client_id and api_key (client_secret). Use this to RECOVER an api_key you've misplaced.

Endpoint:
GET https://apx.didit.me/auth/v2/organizations/me/{org_id}/applications/{app_id}/

Authentication:
Authorization: Bearer <access_token>
Get a token via POST /programmatic/login/.

Path parameters:
\- org_id (UUID, required) — Organization that owns the application. Get via GET /organizations/me/.
\- app_id (UUID, required) — Application UUID. Returned by POST /programmatic/verify-email/ (in the application.uuid field), by POST /organizations/me/{org_id}/applications/, or visible in the Didit console.

curl example:
curl "https://apx.didit.me/auth/v2/organizations/me/<ORG_ID>/applications/<APP_ID>/" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

Response (200 OK):
\{
"uuid": "b2c3d4e5-6789-...",
"name": "My App",
"client_id": "S9LIYGSoWNuGMLHsvEt9dQ",
"api_key": "sk_live_example_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"website_url": "https://example.com",
"redirect_uris": ["https://example.com/callback"],
"terms_url": "https://example.com/terms",
"privacy_url": "https://example.com/privacy",
"description": "Production application",
"created_at": "2025-06-01T10:00:00Z",
"data_location": "eu",
"products": [
\{ "product": "identity", "status": "enabled", "modules": { "user_verification": true, "business_verification": true, "case_management": true } },
\{ "product": "transactions", "status": "disabled", "modules": { "travel_rule": true, "case_management": true } },
\{ "product": "authentication", "status": "disabled", "modules": {} }
]
}

How to use the response:
\- api_key → set as the x-api-key header on EVERY call to https://verification.didit.me/v3/... (sessions, workflows, questionnaires, AML monitoring, billing, etc.).
\- client_id → shown alongside api_key for OAuth-style introspection scenarios. Routine verification calls only need api_key.
\- data_location → where the application's verification data is stored and processed: "eu" (European Union, Ireland). Chosen when the application is created; "au" (Australia, Sydney) and "mx" (Mexico) are coming soon.
\- products → read-only. Always all three products in this order: identity, transactions, authentication. Each has a status (enabled, early_access or disabled) and its module switches (true or false). identity modules: user_verification, business_verification, case_management. transactions modules: travel_rule, case_management. authentication has none ({}).

Failure modes:
\- 401: { "detail": "Invalid access token" } or { "detail": "Expired access token" } when the token is malformed or expired.
\- 403: { "detail": "Only organization owners and admins can manage applications." } when you are a member of the organization but not an owner or admin.
\- 403: { "detail": "Your access to this organization is suspended." } when your membership in the organization is suspended.
\- 403: { "detail": "You do not have permission to perform this action." } when the request has no Authorization header.
\- 404: { "detail": "Organization not found." } when the organization does not exist or you are not a member of it, or { "detail": "Application not found." } when the application is not in that organization.

When to call:
\- After programmatic login from a new machine — you have an access_token but not the api_key, and you need x-api-key to start calling verification.didit.me.
\- Auditing your applications — list all apps with GET /organizations/me/{org_id}/applications/, then read each.

Note:
This endpoint does not rotate the credential. It returns the application's current api_key on every GET, so there is no "show api_key once" model.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\</pre>



      
      

Enganxa a



## OpenAPI

````yaml ca/openapi-auth.json GET /organizations/me/{org_id}/applications/{app_id}/
openapi: 3.0.0
info:
  version: 1.0.0
  title: Didit Auth API
  description: >-
    API de registre i autenticació programàtica per a desenvolupadors i agents
    d'IA. Registra't en 2 crides d'API -- sense necessitat de navegador. La
    plataforma de verificació d'identitat més adaptada a agents.


    ## Base URL


    Tots els endpoints d'aquesta especificació estan allotjats a
    `https://apx.didit.me/auth/v2`. És un amfitrió diferent del de l'API de
    verificació (`https://verification.didit.me/v3`). Tingues-ho en compte:
    aquest amfitrió d'autenticació emet els teus **tokens d'accés JWT** i et
    permet llistar i gestionar les teves **organitzacions** i **aplicacions**.
    L'amfitrió de verificació és on crides sessions, fluxos de treball, AML,
    etc., i t'hi autentiques amb la **`api_key`** que retorna aquesta API.


    ## Com funciona el flux d'autenticació


    1. `POST /programmatic/register/` — envia correu electrònic + contrasenya.

    2. Rep un codi alfanumèric de 6 caràcters per correu electrònic.

    3. `POST /programmatic/verify-email/` — envia el codi. Reps com a resposta
    un `access_token` JWT, un `refresh_token`, una organització i una aplicació
    predeterminada amb `client_id` + `api_key`.

    4. Guarda la `api_key`. Fes-la servir com a `x-api-key` per a cada crida a
    `https://verification.didit.me/v3/...`.

    5. Des de qualsevol màquina en el futur, `POST /programmatic/login/`
    bescanvia el teu correu electrònic + contrasenya per un JWT nou; després
    crida `GET /organizations/me/` i els endpoints d'aplicació per recuperar o
    rotar credencials.


    El JWT només és necessari per als endpoints de **Gestió de comptes**
    d'aquesta especificació; el trànsit de l'API de verificació utilitza la
    `api_key` de llarga durada, no el JWT.


    ## Convencions


    - Tots els cossos de sol·licitud i resposta són JSON (`Content-Type:
    application/json`).

    - **Utilitza una adreça de correu electrònic real i que pugui rebre
    missatges quan provis `POST /programmatic/register/`.** L'endpoint envia el
    codi de verificació de manera síncrona, de manera que les adreces en dominis
    de prova reservats (`@example.com`, `@example.org`, `@*.test`, `@*.example`,
    `@*.invalid`) són rebutjades pel lliurament de correu i la sol·licitud
    retorna un `500`. Substitueix el marcador de posició `you@yourdomain.com`
    dels exemples per una bústia d'entrada que puguis llegir realment.

    - Els errors de validació retornen HTTP `400` amb un d'aquests dos formats:
    `{"field": ["message", ...]}` per a problemes a nivell de camp, o
    `{"detail": "message"}` per a errors de regles de negoci. Alguns validadors
    (robustesa de la contrasenya en registrar-se, caducitat del codi en
    verificar el correu) responen actualment amb una matriu simple `["message"]`
    en lloc del format amb clau de camp -- es tracta d'una inconsistència
    coneguda del servidor, de manera que el codi del client hauria d'acceptar
    ambdós formats.

    - Els errors d'autenticació es retornen com a `{"detail": "..."}` amb HTTP
    `401` (token de portador no vàlid) o `403` (manca el token de portador /
    privilegis insuficients).

    - Les respostes de límit de freqüència inclouen un camp `wait` amb el temps
    d'espera en segons.
servers:
  - url: https://apx.didit.me/auth/v2
    description: Servidor d'autenticació de producció
security: []
tags:
  - name: Programmatic Auth
    description: >-
      Cicle de vida del compte amb correu electrònic i contrasenya: registre,
      verificació, inici de sessió. Retorna el `access_token` JWT que utilitzes
      amb els endpoints de Gestió de comptes, a més (en verificar) del
      `client_id` i la `api_key` de la teva primera aplicació.
  - name: Account Management
    description: >-
      Endpoints autenticats (Bearer JWT) que llisten organitzacions i creen,
      obtenen o actualitzen aplicacions. Utilitza'ls per recuperar o rotar la
      `api_key` amb la qual autentiques les crides a l'API de verificació.
paths:
  /organizations/me/{org_id}/applications/{app_id}/:
    get:
      tags:
        - Account Management
      summary: Obtenir les credencials de l'aplicació
      description: >-
        Llegeix el registre complet d'una aplicació, inclosos `client_id` i
        `api_key`. Utilitza això per recuperar una `api_key` perduda.
      operationId: get_application_credentials
      parameters:
        - name: org_id
          in: path
          required: true
          description: UUID de l'organització propietària de l'aplicació.
          schema:
            type: string
            format: uuid
            example: a1b2c3d4-5678-90ab-cdef-111111111111
        - name: app_id
          in: path
          required: true
          description: UUID de l'aplicació les credencials de la qual vols llegir.
          schema:
            type: string
            format: uuid
            example: b2c3d4e5-6789-01bc-defg-222222222222
      responses:
        '200':
          description: Registre de l'aplicació que inclou el seu `client_id` i `api_key`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
              examples:
                Success:
                  value:
                    uuid: b2c3d4e5-6789-01bc-defg-222222222222
                    name: My App
                    client_id: S9LIYGSoWNuGMLHsvEt9dQ
                    api_key: sk_live_example_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                    website_url: https://example.com
                    redirect_uris:
                      - https://example.com/callback
                    terms_url: https://example.com/terms
                    privacy_url: https://example.com/privacy
                    description: Production application
                    created_at: '2025-06-01T10:00:00Z'
                    data_location: eu
                    products:
                      - product: identity
                        status: enabled
                        modules:
                          user_verification: true
                          business_verification: true
                          case_management: true
                      - product: transactions
                        status: disabled
                        modules:
                          travel_rule: true
                          case_management: true
                      - product: authentication
                        status: disabled
                        modules: {}
        '401':
          description: >-
            El token d'accés està mal format, no és vàlid o ha caducat. Obtén-ne
            un de nou amb `POST /programmatic/login/`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthError'
              examples:
                InvalidToken:
                  value:
                    detail: Invalid access token
                ExpiredToken:
                  value:
                    detail: Expired access token
        '403':
          description: >-
            No pots llegir aquesta aplicació. Un membre de l'organització que no
            sigui propietari o administrador rep `Only organization owners and
            admins can manage applications.` Un propietari o administrador amb
            l'accés suspès a l'organització rep `Your access to this
            organization is suspended.` Una sol·licitud sense capçalera
            `Authorization` rep `You do not have permission to perform this
            action.`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthError'
              examples:
                NotOwnerOrAdmin:
                  summary: Membre que no és ni propietari ni administrador
                  value:
                    detail: >-
                      Only organization owners and admins can manage
                      applications.
                Suspended:
                  summary: Membresia suspesa
                  value:
                    detail: Your access to this organization is suspended.
                MissingToken:
                  summary: Sense capçalera Authorization
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            L'organització no existeix o no en sou membre, o l'aplicació no
            existeix en aquesta organització.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthError'
              examples:
                OrganizationNotFound:
                  summary: No s'ha trobat l'organització, o no en ets membre
                  value:
                    detail: Organization not found.
                ApplicationNotFound:
                  summary: No existeix aquesta aplicació en aquesta organització
                  value:
                    detail: Application not found.
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl
            "https://apx.didit.me/auth/v2/organizations/me/$ORG_ID/applications/$APP_ID/"
            \
              -H "Authorization: Bearer $ACCESS_TOKEN"
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Use the access token that account.login returns.
            client = Didit(account_token="YOUR_ACCESS_TOKEN")

            result = client.account.applications.retrieve(
                "a1b2c3d4-5678-90ab-cdef-111111111111",
                "b2c3d4e5-6789-01bc-defg-222222222222",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Use the access token that account.login returns.
            const didit = new Didit({ accountToken: "YOUR_ACCESS_TOKEN" });

            const result = await didit.account.applications.retrieve(
              "a1b2c3d4-5678-90ab-cdef-111111111111",
              "b2c3d4e5-6789-01bc-defg-222222222222",
            );
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Use the access token that account.login returns.\nclient := didit.NewClient(option.WithAccountToken(\"YOUR_ACCESS_TOKEN\"))\n\nresult, err := client.Account.Applications.Retrieve(ctx, \"a1b2c3d4-5678-90ab-cdef-111111111111\", \"b2c3d4e5-6789-01bc-defg-222222222222\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Use the access token that account.login returns.

            Didit client =
            Didit.builder().accountToken("YOUR_ACCESS_TOKEN").build();


            var result =
            client.account().applications().retrieve("a1b2c3d4-5678-90ab-cdef-111111111111",
            "b2c3d4e5-6789-01bc-defg-222222222222");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Use the access token that account.login returns.

            $didit = new DiditClient(accountToken: 'YOUR_ACCESS_TOKEN');


            $result =
            $didit->account->applications->retrieve('a1b2c3d4-5678-90ab-cdef-111111111111',
            'b2c3d4e5-6789-01bc-defg-222222222222');

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

            # Use the access token that account.login returns.
            didit = Didit::Client.new(account_token: "YOUR_ACCESS_TOKEN")

            result = didit.account.applications.retrieve(
              "a1b2c3d4-5678-90ab-cdef-111111111111",
              "b2c3d4e5-6789-01bc-defg-222222222222"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Use the access token that account.login returns.

            using var client = new DiditClient(new DiditClientOptions {
            AccountToken = "YOUR_ACCESS_TOKEN" });


            var result = await
            client.Account.Applications.RetrieveAsync("a1b2c3d4-5678-90ab-cdef-111111111111",
            "b2c3d4e5-6789-01bc-defg-222222222222");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    Application:
      type: object
      description: >-
        Registre complet de l'aplicació. `uuid`, `client_id` i `api_key` no
        canvien mai després de la creació. `data_location` tampoc no canvia,
        excepte un sol cop a l'aplicació de producció creada amb la teva
        organització, abans d'utilitzar-la (consulta la sol·licitud
        d'actualització).
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            UUID de l'aplicació. Utilitza'l com a `{app_id}` en les crides
            posteriors.
          example: b2c3d4e5-6789-01bc-defg-222222222222
        name:
          type: string
          description: Nom visible de l'aplicació que es mostra a la consola de Didit.
          example: Acme Production App
        client_id:
          type: string
          description: >-
            Identificador públic de client, segur per incrustar en fluxos
            d'estil OAuth.
          example: S9LIYGSoWNuGMLHsvEt9dQ
        api_key:
          type: string
          description: >-
            Secret de llarga durada (també anomenat `client_secret`). Utilitza'l
            com a capçalera `x-api-key` per a cada crida a
            `https://verification.didit.me/v3/...` (sessions, fluxos de treball,
            AML, etc.). Tracta'l com una credencial; no l'exposis mai al costat
            del client. Les claus noves comencen amb `sk_live_` (aplicació de
            producció) o `sk_test_` (aplicació de sandbox), seguits de 43
            caràcters segurs per a URL (lletres, dígits, `-` i `_`). Les claus
            creades abans d'aquest format no tenen prefix i continuen funcionant
            sense canvis. Durant les 72 hores posteriors a la recuperació del
            teu compte, les operacions de llistar, consultar i actualitzar
            retornen una cadena buida aquí en lloc de la clau.
          example: sk_live_example_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        website_url:
          type: string
          nullable: true
          description: URL del lloc web o de l'aplicació associada a aquesta aplicació.
          example: https://acme.example
        redirect_uris:
          type: array
          items:
            type: string
          description: >-
            URI de redirecció permeses per a fluxos de redirecció de verificació
            i d'estil OAuth.
          example:
            - https://acme.example/callback
        terms_url:
          type: string
          nullable: true
          description: >-
            URL de les condicions del servei que es mostra al flux de
            verificació.
          example: https://acme.example/terms
        privacy_url:
          type: string
          nullable: true
          description: >-
            URL de la política de privadesa que es mostra al flux de
            verificació.
          example: https://acme.example/privacy
        description:
          type: string
          nullable: true
          description: Descripció interna de l'aplicació (no es mostra als usuaris finals).
        created_at:
          type: string
          format: date-time
          example: '2025-06-01T10:00:00Z'
        data_location:
          $ref: '#/components/schemas/ApplicationDataLocation'
        products:
          type: array
          readOnly: true
          description: >-
            Els productes de l'aplicació. Sempre tots tres, en aquest ordre:
            `identity`, `transactions`, `authentication`. Una nova aplicació té
            `identity` habilitat amb tots els mòduls activats, i `transactions`
            i `authentication` inhabilitats. Només lectura: s'ignora la clau
            `products` en un cos de creació o actualització.
          items:
            $ref: '#/components/schemas/ApplicationProduct'
          example:
            - product: identity
              status: enabled
              modules:
                user_verification: true
                business_verification: true
                case_management: true
            - product: transactions
              status: disabled
              modules:
                travel_rule: true
                case_management: true
            - product: authentication
              status: disabled
              modules: {}
    AuthError:
      type: object
      description: Embolcall d'error d'autenticació / autorització / de recurs no trobat.
      properties:
        detail:
          type: string
          example: Invalid access token
    ApplicationDataLocation:
      type: string
      enum:
        - eu
        - au
        - mx
      description: >-
        On s'emmagatzemen i es processen les dades de verificació de
        l'aplicació, que se selecciona en crear l'aplicació. `eu` és la Unió
        Europea (Irlanda), l'opció per defecte. `au` (Austràlia, Sydney) i `mx`
        (Mèxic) estaran disponibles properament: una sol·licitud que els indiqui
        respon 400 `This data location is not available yet.` L'aplicació de
        sandbox d'una organització sempre és a la Unió Europea.
      example: eu
    ApplicationProduct:
      type: object
      description: >-
        Un producte d'una aplicació i el seu estat. Només de lectura: els
        endpoints de l'aplicació el retornen i l'ignoren al cos de la
        sol·licitud.
      properties:
        product:
          type: string
          enum:
            - identity
            - transactions
            - authentication
          description: >-
            `identity` (Verificació d'identitat), `transactions` (Monitoratge de
            transaccions) o `authentication` (Autenticació).
          example: identity
        status:
          type: string
          enum:
            - enabled
            - early_access
            - disabled
          description: >-
            Si el producte està activat per a aquesta aplicació. `early_access`
            només s'aplica a `authentication`, que Didit activa per tu.
          example: enabled
        modules:
          type: object
          additionalProperties:
            type: boolean
          description: >-
            Interruptors de mòduls del producte, cadascun `true` o `false`.
            `identity` conté `user_verification`, `business_verification` i
            `case_management`. `transactions` conté `travel_rule` i
            `case_management`. `authentication` no en conté cap (`{}`).
            `case_management` és un sol paràmetre de configuració mostrat tant a
            `identity` com a `transactions`, de manera que té el mateix valor a
            tots dos.
          example:
            user_verification: true
            business_verification: true
            case_management: true
      required:
        - product
        - status
        - modules
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        `access_token` JWT signat amb RS256 retornat per `POST
        /programmatic/login/` o `POST /programmatic/verify-email/`. Envia'l com
        a `Authorization: Bearer <access_token>`. La durada per defecte és de
        86400 segons (24 h). Aquest token només és vàlid per als endpoints de
        gestió de comptes a `apx.didit.me/auth/v2`. L'API de verificació
        (`verification.didit.me/v3`) utilitza en el seu lloc la `api_key` de
        llarga durada com a `x-api-key`.

````

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