Saltar para o conteúdo principal
POST
curl
Crie um relatório em rascunho associado a um caso. Prefira esta opção ao endpoint de criação autónomo quando já tiver o caso aberto - pode omitir template e derivar report_type/jurisdiction diretamente.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. 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 exceto se for fornecido um modelo; caso contrário, é utilizado o report_type do modelo.

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

Obrigatório exceto se for fornecido um modelo.

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

UUID do modelo de relatório; a respetiva field_config preenche o rascunho antes da intercalação dos dados derivados do caso.

transactions
string<uuid>[] | null

Transações a anexar; por predefinição, as transações associadas 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 ex., 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 reportante emitido pela UIF.

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

Secções narrativas 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 7 de novembro de 2026