Get the signed STR message frame

Returns the signed on-wire STR frame for a message identified by its NUOp: the persisted on-wire bytes decoded to XML and labeled reconstructed (the literal sent bytes are not separately retained). The artifact is served WHOLE — every identity exactly as transmitted, with no masking and no content transformation. It is guarded separately from the message log: reading the log (list and metadata) does not open the frame. A message with no retained on-wire bytes (an inbound row, or an outbound without a retry payload) answers 200 with payloadFormat “structured” and no reconstructedXml — the message exists and the frame was never retained; that is the legitimate answer, not an error. A NUOp that matches no message answers 404. The NUOp is a 23-character BACEN identifier: ISPB[8]+DATE[8]+SEQ[7].

GET /v1/str/messages/{nuOp}/frame

Get the signed STR message frame

cURL

curl --request GET \
  --url https://api.example.com/v1/str/messages/{nuOp}/frame \
  --header 'Authorization: Bearer <token>'

200

{
  "correlationId": "req-7a3f9c2e",
  "nuOp": "12345678202605040000001",
  "payloadFormat": "reconstructed",
  "reconstructedXml": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

nuOp · string · requerido

Message NUOp (23 characters: ISPB[8]+DATE[8]+SEQ[7]).

Required string length: 23

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

Respuesta

200

application/json

OK

correlationId · string · requerido

Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace.

Ejemplo:

"req-7a3f9c2e"

nuOp · string · requerido

STR operation number (NUOp) the frame belongs to, 23 characters: 8-character alphanumeric ISPB + 8-digit date + 7-digit sequence. Echoed so the body identifies itself.

Required string length: 23

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

Ejemplo:

"12345678202605040000001"

payloadFormat · enum<string> · requerido

Discriminator for this body: 'reconstructed' means reconstructedXml carries the frame, 'structured' means no on-wire bytes were retained for this message and there is no frame to return (a legitimate 200, not an error).

Opciones disponibles: reconstructed, structured

Ejemplo:

"reconstructed"

reconstructedXml · string

The persisted on-wire STR payload decoded to UTF-8 XML, labeled reconstructed (the literal sent bytes are not separately retained). Omitted when payloadFormat is 'structured'.