curl --request POST \
  --url https://api.example.com/v1/src/consultations/{id}/institution-record \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "exceptional_proceed",
  "registeredBy": "maria.compliance@bank.example",
  "circumstance": "<string>",
  "explanation": "<string>",
  "justification": "Holder attested inability to remove the protection; branch manager approved under policy X."
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/src/consultations/{id}/institution-record"

	payload := strings.NewReader("{\n  \"kind\": \"exceptional_proceed\",\n  \"registeredBy\": \"maria.compliance@bank.example\",\n  \"circumstance\": \"<string>\",\n  \"explanation\": \"<string>\",\n  \"justification\": \"Holder attested inability to remove the protection; branch manager approved under policy X.\"\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({
    kind: 'exceptional_proceed',
    registeredBy: 'maria.compliance@bank.example',
    circumstance: '<string>',
    explanation: '<string>',
    justification: 'Holder attested inability to remove the protection; branch manager approved under policy X.'
  })
};

fetch('https://api.example.com/v1/src/consultations/{id}/institution-record', 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/{id}/institution-record"

payload = {
    "kind": "exceptional_proceed",
    "registeredBy": "maria.compliance@bank.example",
    "circumstance": "<string>",
    "explanation": "<string>",
    "justification": "Holder attested inability to remove the protection; branch manager approved under policy X."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "circumstance": "<string>",
  "explanation": "<string>",
  "filedBy": "m2m:core-banking-integration",
  "justification": "<string>",
  "kind": "exceptional_proceed",
  "registeredAt": "2023-11-07T05:31:56Z",
  "registeredBy": "maria.compliance@bank.example"
}

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

Register an institution record

Registers the institution’s record for a consultation that completed with an active restriction. Send kind: exceptional_proceed with a justification and a circumstance when the institution proceeds despite the restriction. Send kind: refusal_explanation with the explanation that the institution gave when it refused.

A consultation holds one record, and a second request returns 409 with code SRC-0101. A consultation that did not complete with an active restriction returns 409 with code SRC-0102.

POST

src

consultations

{id}

institution-record

curl --request POST \
  --url https://api.example.com/v1/src/consultations/{id}/institution-record \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "exceptional_proceed",
  "registeredBy": "maria.compliance@bank.example",
  "circumstance": "<string>",
  "explanation": "<string>",
  "justification": "Holder attested inability to remove the protection; branch manager approved under policy X."
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/src/consultations/{id}/institution-record"

	payload := strings.NewReader("{\n  \"kind\": \"exceptional_proceed\",\n  \"registeredBy\": \"maria.compliance@bank.example\",\n  \"circumstance\": \"<string>\",\n  \"explanation\": \"<string>\",\n  \"justification\": \"Holder attested inability to remove the protection; branch manager approved under policy X.\"\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({
    kind: 'exceptional_proceed',
    registeredBy: 'maria.compliance@bank.example',
    circumstance: '<string>',
    explanation: '<string>',
    justification: 'Holder attested inability to remove the protection; branch manager approved under policy X.'
  })
};

fetch('https://api.example.com/v1/src/consultations/{id}/institution-record', 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/{id}/institution-record"

payload = {
    "kind": "exceptional_proceed",
    "registeredBy": "maria.compliance@bank.example",
    "circumstance": "<string>",
    "explanation": "<string>",
    "justification": "Holder attested inability to remove the protection; branch manager approved under policy X."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "circumstance": "<string>",
  "explanation": "<string>",
  "filedBy": "m2m:core-banking-integration",
  "justification": "<string>",
  "kind": "exceptional_proceed",
  "registeredAt": "2023-11-07T05:31:56Z",
  "registeredBy": "maria.compliance@bank.example"
}

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

Autorizações

Authorization

string

header

obrigatório

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

Cabeçalhos

X-Request-ID

string

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

Parâmetros de caminho

string

obrigatório

Consultation identifier (UUID). A malformed identifier returns 422 SRC-0002 with a field violation on id.

Exemplo:

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

Corpo

application/json

kind

enum<string>

obrigatório

Which paragraph of art. 2º-A this record answers: "exceptional_proceed" (§1º — contracted despite the active restriction) or "refusal_explanation" (§2º — refused, and this is what the interested party was told). REQUIRED. It decides which prose members are mandatory and which are refused.

Opções disponíveis:

exceptional_proceed,

refusal_explanation

Exemplo:

"exceptional_proceed"

registeredBy

string

obrigatório

Who filed the record, as an institution-side identity. REQUIRED for both kinds, 1..255 characters.

Required string length: 1 - 255

Exemplo:

"maria.compliance@bank.example"

circumstance

string

The exceptional circumstance alleged (for instance, a holder prevented from removing the protection request). REQUIRED when kind is "exceptional_proceed", 1..1000 characters; REFUSED when kind is "refusal_explanation".

Required string length: 1 - 1000

explanation

string

Content of the explanation given to the interested party. REQUIRED when kind is "refusal_explanation", 1..2000 characters; REFUSED when kind is "exceptional_proceed".

Required string length: 1 - 2000

justification

string

Mandatory justification for proceeding despite the active restriction. REQUIRED when kind is "exceptional_proceed", 1..2000 characters; REFUSED when kind is "refusal_explanation".

Required string length: 1 - 2000

Exemplo:

"Holder attested inability to remove the protection; branch manager approved under policy X."

Resposta

Created

circumstance

string

obrigatório

The exceptional circumstance alleged, as filed. Empty on a refusal-explanation record.

explanation

string

obrigatório

The explanation given to the interested party, as filed. Empty on an exceptional-proceed record.

filedBy

string

obrigatório

Exemplo:

"m2m:core-banking-integration"

justification

string

obrigatório

The mandatory justification, as filed. Empty on a refusal-explanation record.

kind

string

obrigatório

Which paragraph of art. 2º-A this record answers: "exceptional_proceed" (§1º) or "refusal_explanation" (§2º). It is the member that says which prose members carry text.

Exemplo:

"exceptional_proceed"

registeredAt

string<date-time>

obrigatório

Registration instant (RFC3339, UTC). The record is immutable, so this never changes.

registeredBy

string

obrigatório

Who filed the record (institution-side identity).

Exemplo:

"maria.compliance@bank.example"

Consultas

Registros da instituição

Evidências

Painel

Credenciais

Casos de operador

Tratamento de erros

Register an institution record

Autorizações

Cabeçalhos

Parâmetros de caminho

Corpo

Resposta