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

# Crear informe FIU des de cas via API

> Crea amb Didit un esborrany d'informe SAR, STR, CTR o un altre informe FIU des d'un cas, omplert amb una plantilla, el subjecte i les transaccions.



Prompt de l'API per crear un informe des d'un cas
        Copia el prompt al porta-retalls



      
      

\<pre>

\`Create a draft FIU report from a case through the Management API.

Endpoint:
POST https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/

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

Request body (all optional if a template is given):
\{
"template": "<report-template-uuid>",   // seeds rentity_id, submission_code, currency_code_local, etc.
"report_type": "SAR",                     // required if no template
"jurisdiction": "US",                     // required if no template
"transactions": ["<transaction-uuid>"]    // optional - defaults to the case's linked transactions
}

Behavior:
\- Draft is auto-populated from the template (if given) plus the case's subject, linked transactions, and a narrative structured around the five Ws (who/what/when/where/why/how) for SAR/STR/TFR.
\- Status starts as DRAFT. Call validate then finalize next.

Example call:
curl -X POST "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"template": "<uuid>"}'

Response 201: RegulatoryReportDetail with status "DRAFT".

Failure modes:
\- 400 - the referenced template was not found.
\- 401/403 - auth/permission errors (requires write:cases).

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Enganxa a

Crea un informe en esborrany associat a un cas. Prefereix això a l'endpoint de creació independent quan ja tinguis el cas obert: pot prescindir de `template` i derivar `report_type` i `jurisdiction` directament.## Relacionats- [Llistar informes](https://docs.didit.me/ca/management-api/regulatory-reports/list.md)
- [Validar informe](https://docs.didit.me/ca/management-api/regulatory-reports/validate.md)
- [Finalitzar informe](https://docs.didit.me/ca/management-api/regulatory-reports/finalize.md)
- [Eliminar informe](https://docs.didit.me/ca/management-api/regulatory-reports/delete.md)


## OpenAPI

````yaml ca/openapi-25.json POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/
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/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/:
    post:
      tags:
        - Regulatory Reports
      summary: Crea un informe a partir d'un cas
      description: >-
        Crea un esborrany d'informe de la UIF per al cas: estat DRAFT, emplenat
        automàticament a partir de la plantilla opcional més el subjecte del
        cas, les transaccions vinculades i la descripció dels fets. Valida'l i
        després finalitza'l per generar el fitxer XML goAML i el PDF.
      operationId: create_case_regulatory_report
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID de l'organització.
        - name: application_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID de l'aplicació.
        - name: case_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: c1a5e000-0000-4000-8000-000000000001
          description: UUID del cas.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                report_type:
                  type: string
                  enum:
                    - SAR
                    - STR
                    - CTR
                    - TTR
                    - UTR
                    - IFT
                    - CBR
                    - TFR
                  description: >-
                    Obligatori tret que s'indiqui una plantilla; en cas
                    contrari, s'utilitza el report_type de la plantilla.
                jurisdiction:
                  type: string
                  minLength: 2
                  maxLength: 2
                  description: Obligatori tret que s'indiqui una plantilla.
                template:
                  type: string
                  format: uuid
                  nullable: true
                  description: >-
                    UUID de la plantilla d'informe; el seu field_config
                    inicialitza l'esborrany abans de fusionar-hi les dades
                    derivades del cas.
                transactions:
                  type: array
                  items:
                    type: string
                    format: uuid
                  nullable: true
                  description: >-
                    Transaccions a adjuntar; per defecte són les transaccions
                    enllaçades al cas.
                rentity_id:
                  type: string
                  nullable: true
                rentity_branch:
                  type: string
                  nullable: true
                submission_code:
                  type: string
                  enum:
                    - E
                    - M
                  default: E
                entity_reference:
                  type: string
                  nullable: true
                fiu_ref_number:
                  type: string
                  nullable: true
                currency_code_local:
                  type: string
                  minLength: 3
                  maxLength: 3
                  nullable: true
                submission_date:
                  type: string
                  format: date-time
                  nullable: true
                reporting_person:
                  type: object
                location:
                  type: object
                reason:
                  type: string
                  nullable: true
                action:
                  type: string
                  nullable: true
                activity:
                  type: string
                  nullable: true
                narrative:
                  type: object
                  properties:
                    who:
                      type: string
                    what:
                      type: string
                    when:
                      type: string
                    where:
                      type: string
                    why:
                      type: string
                    how:
                      type: string
                report_indicators:
                  type: array
                  items:
                    type: string
                included_fields:
                  type: array
                  items:
                    type: string
            example:
              template: 7ec00000-0000-4000-8000-000000000006
      responses:
        '201':
          description: Informe en esborrany creat.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegulatoryReportDetail'
        '400':
          description: No s'ha trobat la plantilla referenciada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/regulatory-reports/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"template": "7ec00000-0000-4000-8000-000000000006"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            # and DIDIT_APPLICATION_ID.
            client = Didit()

            result = client.cases.regulatory_reports.create(
                "c1a5e000-0000-4000-8000-000000000001",
                template="7ec00000-0000-4000-8000-000000000006",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            const didit = new Didit();


            const result = await
            didit.cases.regulatoryReports.create("c1a5e000-0000-4000-8000-000000000001",
            {
              template: "7ec00000-0000-4000-8000-000000000006",
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.RegulatoryReports.Create(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesRegulatoryReportsCreateParams{\n\tTemplate: didit.String(\"7ec00000-0000-4000-8000-000000000006\"),\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.CasesRegulatoryReportsCreateParams;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            Didit client = new Didit();


            var result =
            client.cases().regulatoryReports().create("c1a5e000-0000-4000-8000-000000000001",
            CasesRegulatoryReportsCreateParams.builder()
                    .template("7ec00000-0000-4000-8000-000000000006")
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            $didit = new DiditClient();


            $result =
            $didit->cases->regulatoryReports->create('c1a5e000-0000-4000-8000-000000000001',
            [
                'template' => '7ec00000-0000-4000-8000-000000000006',
            ]);

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

            # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            # and DIDIT_APPLICATION_ID.
            didit = Didit::Client.new

            result = didit.cases.regulatory_reports.create(
              "c1a5e000-0000-4000-8000-000000000001",
              template: "7ec00000-0000-4000-8000-000000000006"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            using var client = new DiditClient();


            var result = await
            client.Cases.RegulatoryReports.CreateAsync("c1a5e000-0000-4000-8000-000000000001",
            new CasesRegulatoryReportsCreateParams

            {
                Template = "7ec00000-0000-4000-8000-000000000006",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    RegulatoryReportDetail:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        case_uuid:
          type: string
          format: uuid
        case_number:
          type: string
          nullable: true
        report_type:
          type: string
          enum:
            - SAR
            - STR
            - CTR
            - TTR
            - UTR
            - IFT
            - CBR
            - TFR
        report_type_display:
          type: string
        report_code:
          type: string
          description: Codi d'informe goAML derivat de report_type, p. ex. STR, CTR, BCR.
        report_number:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - DRAFT
            - VALIDATED
            - FINALIZED
        status_display:
          type: string
        jurisdiction:
          type: string
          minLength: 2
          maxLength: 2
        rentity_id:
          type: string
          nullable: true
          description: ID de l'entitat informant emès per la FIU.
        rentity_branch:
          type: string
          nullable: true
        submission_code:
          type: string
          enum:
            - E
            - M
        entity_reference:
          type: string
          nullable: true
        fiu_ref_number:
          type: string
          nullable: true
        currency_code_local:
          type: string
          minLength: 3
          maxLength: 3
          nullable: true
        submission_date:
          type: string
          format: date-time
          nullable: true
        reporting_person:
          type: object
        location:
          type: object
        reason:
          type: string
          nullable: true
        action:
          type: string
          nullable: true
        activity:
          type: string
          nullable: true
        narrative:
          type: object
          description: Seccions narratives de les cinc W.
          properties:
            who:
              type: string
            what:
              type: string
            when:
              type: string
            where:
              type: string
            why:
              type: string
            how:
              type: string
        report_indicators:
          type: array
          items:
            type: string
        included_fields:
          type: array
          items:
            type: string
        transactions:
          type: array
          items:
            type: string
            format: uuid
        validation_errors:
          type: array
          description: >-
            Resultat de la validació més recent; cada entrada és un objecte
            {field, message}.
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        validated_at:
          type: string
          format: date-time
          nullable: true
        finalized_at:
          type: string
          format: date-time
          nullable: true
        created_by_email:
          type: string
          nullable: true
        created_by_name:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  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.