Create a consultation

curl --request POST \
  --url https://api.example.com/v1/src/consultations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "document": "52998224725",
  "documentType": "CPF",
  "motivation": {
    "reference": "acct-open-2026-000123",
    "note": "<string>"
  },
  "protectionTypes": [
    "account_opening"
  ],
  "companyConsultationId": "8f14e45f-ceea-467a-9a36-dedd4bea2543",
  "subjectRole": "representative"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/src/consultations"

	payload := strings.NewReader("{\n  \"document\": \"52998224725\",\n  \"documentType\": \"CPF\",\n  \"motivation\": {\n    \"reference\": \"acct-open-2026-000123\",\n    \"note\": \"<string>\"\n  },\n  \"protectionTypes\": [\n    \"account_opening\"\n  ],\n  \"companyConsultationId\": \"8f14e45f-ceea-467a-9a36-dedd4bea2543\",\n  \"subjectRole\": \"representative\"\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({
    document: '52998224725',
    documentType: 'CPF',
    motivation: {reference: 'acct-open-2026-000123', note: '<string>'},
    protectionTypes: ['account_opening'],
    companyConsultationId: '8f14e45f-ceea-467a-9a36-dedd4bea2543',
    subjectRole: 'representative'
  })
};

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

import requests

url = "https://api.example.com/v1/src/consultations"

payload = {
    "document": "52998224725",
    "documentType": "CPF",
    "motivation": {
        "reference": "acct-open-2026-000123",
        "note": "<string>"
    },
    "protectionTypes": ["account_opening"],
    "companyConsultationId": "8f14e45f-ceea-467a-9a36-dedd4bea2543",
    "subjectRole": "representative"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "acceptedAt": "2023-11-07T05:31:56Z",
  "id": "8f14e45f-ceea-467a-9a36-dedd4bea2543",
  "status": "pending"
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

Create a consultation

Accepts a restriction consultation for one CPF or CNPJ and returns 202 with the consultation id. The consultation starts as pending, which is a normal state. Read the outcome with GET /v1/src/consultations/{id} or from the events.

Lerian SRC validates the request before it accepts it, and a refused request sends nothing to BACEN. X-Idempotency is required. Idempotency describes the replay rules and how long Lerian SRC keeps a key.

POST

src

consultations

Create a consultation

curl --request POST \
  --url https://api.example.com/v1/src/consultations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "document": "52998224725",
  "documentType": "CPF",
  "motivation": {
    "reference": "acct-open-2026-000123",
    "note": "<string>"
  },
  "protectionTypes": [
    "account_opening"
  ],
  "companyConsultationId": "8f14e45f-ceea-467a-9a36-dedd4bea2543",
  "subjectRole": "representative"
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/src/consultations"

	payload := strings.NewReader("{\n  \"document\": \"52998224725\",\n  \"documentType\": \"CPF\",\n  \"motivation\": {\n    \"reference\": \"acct-open-2026-000123\",\n    \"note\": \"<string>\"\n  },\n  \"protectionTypes\": [\n    \"account_opening\"\n  ],\n  \"companyConsultationId\": \"8f14e45f-ceea-467a-9a36-dedd4bea2543\",\n  \"subjectRole\": \"representative\"\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({
    document: '52998224725',
    documentType: 'CPF',
    motivation: {reference: 'acct-open-2026-000123', note: '<string>'},
    protectionTypes: ['account_opening'],
    companyConsultationId: '8f14e45f-ceea-467a-9a36-dedd4bea2543',
    subjectRole: 'representative'
  })
};

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

import requests

url = "https://api.example.com/v1/src/consultations"

payload = {
    "document": "52998224725",
    "documentType": "CPF",
    "motivation": {
        "reference": "acct-open-2026-000123",
        "note": "<string>"
    },
    "protectionTypes": ["account_opening"],
    "companyConsultationId": "8f14e45f-ceea-467a-9a36-dedd4bea2543",
    "subjectRole": "representative"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "acceptedAt": "2023-11-07T05:31:56Z",
  "id": "8f14e45f-ceea-467a-9a36-dedd4bea2543",
  "status": "pending"
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Idempotency

string

required

REQUIRED client-supplied idempotency key (1..255 chars). Its absence returns 400 with code SRC-0001. Idempotency describes the replay rules and how long Lerian SRC keeps a key.

Required string length: 1 - 255

X-Request-ID

string

Optional correlation id (UUID) propagated through logs/traces and into the evidence trail.

Body

application/json

document

string

required

CPF (11 numeric digits) or CNPJ (14 characters: 12 alphanumeric [0-9A-Z] positions plus 2 numeric check digits), unmasked. The alphanumeric CNPJ is the official BACEN class [0-9]{11}|[0-9A-Z]{12}[0-9]{2}. Check digits are validated before acceptance.

Pattern: ^([0-9]{11}|[0-9A-Z]{12}[0-9]{2})$

Example:

"52998224725"

documentType

string

required

Type of the consulted document: CPF or CNPJ. Must agree with the document's width.

Example:

"CPF"

motivation

object

required

Mandatory motivation context.

Show child attributes

protectionTypes

string[] | null

required

One or more protection types to consult (account_opening, ownership_change): at least one, no duplicates, each within the official catalog domain.

Example:

["account_opening"]

companyConsultationId

string

The id of the company (CNPJ) consultation that this holder or representative belongs to: the id that the company's own request returned with its 202. Required when subjectRole is holder or representative (422 SRC-0006 when absent). Refused for individual and company (422 SRC-0007 when present). It must name a CNPJ consultation of this deployment, in any status, so you can send both requests at the same time. Otherwise the request returns 422 SRC-0008.

Example:

"8f14e45f-ceea-467a-9a36-dedd4bea2543"

subjectRole

string

The role the consulted document plays: individual | company | holder | representative. OPTIONAL — absent, it is inferred from documentType (CPF → individual, CNPJ → company). Unknown value returns 422 SRC-0004; a role the document type does not admit returns 422 SRC-0005. Declaring the inferred role explicitly does NOT change the idempotency fingerprint.

Example:

"representative"

Response

Accepted

acceptedAt

string<date-time>

required

Acceptance instant (RFC3339, UTC). On an idempotent replay this is the ORIGINAL acceptance instant, never the replay instant.

string

required

Consultation identifier (poll via GET /v1/src/consultations/{id}).

Example:

"8f14e45f-ceea-467a-9a36-dedd4bea2543"

status

string

required

Lifecycle state of the consultation. A newly accepted consultation is always pending — a NORMAL state, never an error. An idempotent REPLAY reports the state the original consultation is in now, so it may be completed or failed.

Example:

"pending"

Consultations

Institution records

Evidence

Dashboard

Credentials

Operator cases

Error handling

Create a consultation

Authorizations

Headers

Body

Response