Search evidence records

curl --request POST \
  --url https://api.example.com/v1/src/evidence/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cursor": "<string>",
  "document": "<string>",
  "documentType": "CPF",
  "kind": "operator_case_closure",
  "limit": 50
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"cursor\": \"<string>\",\n  \"document\": \"<string>\",\n  \"documentType\": \"CPF\",\n  \"kind\": \"operator_case_closure\",\n  \"limit\": 50\n}")

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

	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: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cursor: '<string>',
    document: '<string>',
    documentType: 'CPF',
    kind: 'operator_case_closure',
    limit: 50
  })
};

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

import requests

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

payload = {
    "cursor": "<string>",
    "document": "<string>",
    "documentType": "CPF",
    "kind": "operator_case_closure",
    "limit": 50
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "documentMasked": "529******26",
  "items": [
    {
      "bcbControlCode": "<string>",
      "consultationId": "<string>",
      "kind": "entry_refusal",
      "occurredAt": "2023-11-07T05:31:56Z",
      "recordId": "0192f5c4-1c2f-7c3a-8a1b-9f2e3d4c5b6a",
      "sequence": 1
    }
  ],
  "limit": 50,
  "nextCursor": "<string>"
}

{
  "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": {}
}

Search evidence records

Searches the evidence trail by document and returns the matching records, newest first by occurredAt. The results include requests that Lerian SRC refused before acceptance, which belong to no consultation. When kind is operator_case_closure or credential_operation, document is optional.

The response does not carry the record content. For a record that belongs to a consultation, GET /v1/src/evidence/consultations/{id} returns the content.

POST

src

evidence

records

Search evidence records

curl --request POST \
  --url https://api.example.com/v1/src/evidence/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cursor": "<string>",
  "document": "<string>",
  "documentType": "CPF",
  "kind": "operator_case_closure",
  "limit": 50
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"cursor\": \"<string>\",\n  \"document\": \"<string>\",\n  \"documentType\": \"CPF\",\n  \"kind\": \"operator_case_closure\",\n  \"limit\": 50\n}")

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

	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: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    cursor: '<string>',
    document: '<string>',
    documentType: 'CPF',
    kind: 'operator_case_closure',
    limit: 50
  })
};

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

import requests

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

payload = {
    "cursor": "<string>",
    "document": "<string>",
    "documentType": "CPF",
    "kind": "operator_case_closure",
    "limit": 50
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "documentMasked": "529******26",
  "items": [
    {
      "bcbControlCode": "<string>",
      "consultationId": "<string>",
      "kind": "entry_refusal",
      "occurredAt": "2023-11-07T05:31:56Z",
      "recordId": "0192f5c4-1c2f-7c3a-8a1b-9f2e3d4c5b6a",
      "sequence": 1
    }
  ],
  "limit": 50,
  "nextCursor": "<string>"
}

{
  "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-Request-ID

string

Optional correlation id (UUID) propagated through logs/traces.

Body

application/json

cursor

string

Opaque pagination cursor from a previous page. An invalid cursor returns 400 SRC-0001.

document

string

Required unless kind is credential_operation or operator_case_closure. The consulted document, unmasked: CPF (11 numeric digits) or CNPJ (14 characters, 12 alphanumeric [0-9A-Z] plus 2 numeric check digits). Absent or off-pattern returns 422 SRC-0002, except that absence is accepted when kind is one of those two classes.

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

documentType

enum<string>

Optional declared class of the document: CPF or CNPJ. It filters nothing and does not change the returned documentMasked. A value outside the vocabulary returns 422 SRC-0002 with a violation on this member.

Available options:

CPF,

CNPJ

Example:

"CPF"

kind

enum<string>

Optional record class that restricts the page. When it is credential_operation or operator_case_closure, document is optional. For every other class, document is required. A value outside the vocabulary returns 422 SRC-0002 with a violation on this member.

Available options:

acceptance,

entry_refusal,

dispatch_attempt,

channel_confirmation,

response,

rejection,

duplicate_response,

notification,

client_decision,

refusal_explanation,

credential_operation,

operator_case_closure,

correction

Example:

"operator_case_closure"

limit

integer<int64>

default:50

Page size (1..200).

Required range: 1 <= x <= 200

Example:

50

Response

documentMasked

string

required

The searched document, masked.

Example:

"529******26"

items

object[] | null

required

The page's evidence records, most recently occurred first.

Show child attributes

limit

integer<int64>

required

Effective page size this request was served with.

Example:

50

nextCursor

string | null

required

Opaque cursor for the following page; null on the last page.

Consultations

Institution records

Evidence

Dashboard

Credentials

Operator cases

Error handling

Search evidence records

Authorizations

Headers

Body

Response