Pular para o conteúdo principal
POST
curl
Crie um rascunho de relatório vinculado a um caso. Prefira este endpoint ao endpoint de criação independente quando você já estiver com o caso aberto: ele permite omitir template e deriva report_type/jurisdiction diretamente do caso.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

organization_id
string<uuid>
obrigatório

UUID da organização.

application_id
string<uuid>
obrigatório

UUID da aplicação.

case_uuid
string<uuid>
obrigatório

UUID do caso.

Exemplo:

"c1a5e000-0000-4000-8000-000000000001"

Corpo

application/json
report_type
enum<string>

Obrigatório, a menos que um modelo seja informado; caso contrário, é usado o report_type do modelo.

Opções disponíveis:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
jurisdiction
string

Obrigatório, a menos que um modelo seja informado.

Required string length: 2
template
string<uuid> | null

UUID do modelo de relatório; o field_config dele preenche o rascunho inicial antes de os dados derivados do caso serem mesclados.

transactions
string<uuid>[] | null

Transações a anexar; por padrão, as transações vinculadas ao caso.

rentity_id
string | null
rentity_branch
string | null
submission_code
enum<string>
padrão:E
Opções disponíveis:
E,
M
entity_reference
string | null
fiu_ref_number
string | null
currency_code_local
string | null
Required string length: 3
submission_date
string<date-time> | null
reporting_person
object
location
object
reason
string | null
action
string | null
activity
string | null
narrative
object
report_indicators
string[]
included_fields
string[]

Resposta

Rascunho de relatório criado.

uuid
string<uuid>
case_uuid
string<uuid>
case_number
string | null
report_type
enum<string>
Opções disponíveis:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
report_type_display
string
report_code
string

Código de relatório goAML derivado de report_type, por exemplo STR, CTR, BCR.

report_number
string | null
status
enum<string>
Opções disponíveis:
DRAFT,
VALIDATED,
FINALIZED
status_display
string
jurisdiction
string
Required string length: 2
rentity_id
string | null

ID da entidade declarante emitido pela FIU.

rentity_branch
string | null
submission_code
enum<string>
Opções disponíveis:
E,
M
entity_reference
string | null
fiu_ref_number
string | null
currency_code_local
string | null
Required string length: 3
submission_date
string<date-time> | null
reporting_person
object
location
object
reason
string | null
action
string | null
activity
string | null
narrative
object

Seções narrativas no formato dos cinco Ws.

report_indicators
string[]
included_fields
string[]
transactions
string<uuid>[]
validation_errors
object[]

Resultado da validação mais recente; cada entrada é um objeto {field, message}.

validated_at
string<date-time> | null
finalized_at
string<date-time> | null
created_by_email
string | null
created_by_name
string | null
created_at
string<date-time>
updated_at
string<date-time>
Última modificação em 1 de novembro de 2026