Pular para o conteúdo principal
GET
Get a MED fraud marker

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

idMarcacaoFraude
string
obrigatório

The fraud-marker GUID.

Exemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

Parâmetros de consulta

ispb
string

The ISPB of the direct participant this read is made as. This deployment may act as SEVERAL direct SPI participants - one ISPB each, each with its own JDPI credential - and a fraud marker names no row this deployment holds, so this field is the only thing that says which JD instance to ask. OPTIONAL while it acts as a single participant: omit it and that one answers. REQUIRED once it acts as several - omitted is 422 PIX-0127, and an ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply and guarantee, exactly like payer_ispb on the limits routes: never a credential, never read from a header or a path, and it never widens what your token can reach. Read as the SAME participant that created the marker, or the JD you ask has never heard of it. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9A-Z]{8}$
Exemplo:

"12345678"

Resposta

OK

createdAt
string
obrigatório

JDPI creation timestamp (RFC 3339 UTC).

Exemplo:

"2024-01-01T12:00:00.000Z"

fraudMarkerId
string
obrigatório

Fraud-marker GUID (the natural key).

Exemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

ispb
string
obrigatório

ISPB of the creator PSP.

Exemplo:

"12345678"

status
integer<int64>
obrigatório

stMarcacaoFraude lifecycle code (0=registered, 1=cancelled).

Exemplo:

0

statusDescription
string
obrigatório

Human-readable stMarcacaoFraude label.

Exemplo:

"Registrada"

taxId
string
obrigatório

The flagged document.

Exemplo:

"12345678901"

tpFraude
integer<int64>
obrigatório

Fraud-type code (0..4; 4=Desconhecida is read-only).

Exemplo:

1

tpFraudeDescription
string
obrigatório

Human-readable tpFraude label.

Exemplo:

"Conta laranja"

tpPessoa
integer<int64>
obrigatório

Person-type code (0=Pessoa Fisica, 1=Pessoa Juridica).

Exemplo:

0

tpPessoaDescription
string
obrigatório

Human-readable tpPessoa label.

Exemplo:

"Pessoa Fisica"

updatedAt
string
obrigatório

JDPI last-modification timestamp (RFC 3339 UTC) — the watermark.

Exemplo:

"2024-01-01T12:05:00.000Z"

dictCorrelationId
string

idCorrelacao — the DICT support identifier for this consultar call; quote it to JD when disputing whether the read happened.

Exemplo:

"a7f12465e19f5ca51329479a5bae60c2"

dictReturnedAt
string

dtHrRetornoDict — when DICT answered this consultar (contract 2.16).

Exemplo:

"2023-08-16T10:30:05.025Z"

infractionId
string

Linked infraction GUID, when the marker was auto-created from a closed infraction.

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

infractionIspb
string

Linked infraction's PSP ISPB, when infraction-originated.

Exemplo:

"87654321"

key
string

The flagged Pix key, when known.

Exemplo:

"user@example.com"