Register a MED fraud marker

curl --request POST \
  --url https://api.example.com/v1/med/fraud-markers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "taxId": "12345678901",
  "tpFraude": 1,
  "tpPessoa": 0,
  "ispb": "12345678",
  "key": "user@example.com"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/med/fraud-markers"

	payload := strings.NewReader("{\n  \"taxId\": \"12345678901\",\n  \"tpFraude\": 1,\n  \"tpPessoa\": 0,\n  \"ispb\": \"12345678\",\n  \"key\": \"user@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    taxId: '12345678901',
    tpFraude: 1,
    tpPessoa: 0,
    ispb: '12345678',
    key: 'user@example.com'
  })
};

fetch('https://api.example.com/v1/med/fraud-markers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/med/fraud-markers"

payload = {
    "taxId": "12345678901",
    "tpFraude": 1,
    "tpPessoa": 0,
    "ispb": "12345678",
    "key": "user@example.com"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2024-01-01T12:00:00.000Z",
  "fraudMarkerId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "ispb": "12345678",
  "status": 0,
  "statusDescription": "Registrada",
  "taxId": "12345678901",
  "tpFraude": 1,
  "tpFraudeDescription": "Conta laranja",
  "tpPessoa": 0,
  "tpPessoaDescription": "Pessoa Fisica",
  "updatedAt": "2024-01-01T12:05:00.000Z",
  "dictCorrelationId": "a7f12465e19f5ca51329479a5bae60c2",
  "dictReturnedAt": "2023-08-16T10:30:05.025Z",
  "infractionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "infractionIspb": "87654321",
  "key": "user@example.com"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

med

fraud-markers

curl --request POST \
  --url https://api.example.com/v1/med/fraud-markers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "taxId": "12345678901",
  "tpFraude": 1,
  "tpPessoa": 0,
  "ispb": "12345678",
  "key": "user@example.com"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/med/fraud-markers"

	payload := strings.NewReader("{\n  \"taxId\": \"12345678901\",\n  \"tpFraude\": 1,\n  \"tpPessoa\": 0,\n  \"ispb\": \"12345678\",\n  \"key\": \"user@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    taxId: '12345678901',
    tpFraude: 1,
    tpPessoa: 0,
    ispb: '12345678',
    key: 'user@example.com'
  })
};

fetch('https://api.example.com/v1/med/fraud-markers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/med/fraud-markers"

payload = {
    "taxId": "12345678901",
    "tpFraude": 1,
    "tpPessoa": 0,
    "ispb": "12345678",
    "key": "user@example.com"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2024-01-01T12:00:00.000Z",
  "fraudMarkerId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "ispb": "12345678",
  "status": 0,
  "statusDescription": "Registrada",
  "taxId": "12345678901",
  "tpFraude": 1,
  "tpFraudeDescription": "Conta laranja",
  "tpPessoa": 0,
  "tpPessoaDescription": "Pessoa Fisica",
  "updatedAt": "2024-01-01T12:05:00.000Z",
  "dictCorrelationId": "a7f12465e19f5ca51329479a5bae60c2",
  "dictReturnedAt": "2023-08-16T10:30:05.025Z",
  "infractionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "infractionIspb": "87654321",
  "key": "user@example.com"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency

string

requerido

Idempotency key for this write: any stable business string you choose, sent as the X-Idempotency request header - the same header, by the same name, that the Midaz ledger takes, so one integration sends one thing by one name. Send the SAME value again to retry safely: the plugin projects it deterministically into the GUID form JDPI requires (contract 6), so a repeat lands in the same JDPI dedup slot inside JD's 24h window and the operation is applied once. The raw value is never forwarded verbatim, so correlate JDPI-side logs with the projection rather than with what you sent. The header is REQUIRED: omitting it is refused 400 PIX-0061 before any JDPI call. BREAKING CHANGE: this value used to be the body field idempotencyKey, which no longer exists.

Ejemplo:

"med-fraud-2024-0001"

Cuerpo

application/json

taxId

string

requerido

The flagged document.

Ejemplo:

"12345678901"

tpFraude

integer<int64>

requerido

Fraud-type code on create (0=Falsidade ideologica, 1=Conta laranja, 2=Conta do fraudador, 3=Outra; 4 Desconhecida is read-only).

Ejemplo:

1

tpPessoa

integer<int64>

requerido

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

Ejemplo:

0

ispb

string

The ISPB of the direct participant this operation acts as. This deployment may act as SEVERAL direct SPI participants - one ISPB each, each with its own customers and its own JDPI credential - and this field is the only thing on the request that says which of them acts. OPTIONAL while it acts as a single participant: omit it and that one acts. 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 payerIspb on a transaction: never a credential, never read from a header or a path, and it never widens what your token can reach. It also selects the JDPI channel the call goes out on, so a MED write made under the wrong one reaches a JD that has never heard of this institution. Send it as an absent key, not an empty string; an empty value is refused 400 PIX-0061.

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

Ejemplo:

"12345678"

key

string

The flagged Pix key, if known.

Ejemplo:

"user@example.com"

Respuesta

Accepted

createdAt

string

requerido

JDPI creation timestamp (RFC 3339 UTC).

Ejemplo:

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

fraudMarkerId

string

requerido

Fraud-marker GUID (the natural key).

Ejemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

ispb

string

requerido

ISPB of the creator PSP.

Ejemplo:

"12345678"

status

integer<int64>

requerido

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

Ejemplo:

0

statusDescription

string

requerido

Human-readable stMarcacaoFraude label.

Ejemplo:

"Registrada"

taxId

string

requerido

The flagged document.

Ejemplo:

"12345678901"

tpFraude

integer<int64>

requerido

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

Ejemplo:

1

tpFraudeDescription

string

requerido

Human-readable tpFraude label.

Ejemplo:

"Conta laranja"

tpPessoa

integer<int64>

requerido

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

Ejemplo:

0

tpPessoaDescription

string

requerido

Human-readable tpPessoa label.

Ejemplo:

"Pessoa Fisica"

updatedAt

string

requerido

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

Ejemplo:

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

Ejemplo:

"a7f12465e19f5ca51329479a5bae60c2"

dictReturnedAt

string

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

Ejemplo:

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

infractionId

string

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

Ejemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

infractionIspb

string

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

Ejemplo:

"87654321"

key

string

The flagged Pix key, when known.

Ejemplo:

"user@example.com"

APIs del participante directo

APIs de participantes indirectos

Register a MED fraud marker

Autorizaciones

Encabezados

Cuerpo

Respuesta