Skip to main content
GET
Get the signed STR message frame

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

nuOp
string
obrigatório

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

Required string length: 23
Pattern: ^[0-9A-Z]{8}[0-9]{15}$

Resposta

OK

correlationId
string
obrigatório

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

Exemplo:

"req-7a3f9c2e"

nuOp
string
obrigatório

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}$
Exemplo:

"12345678202605040000001"

payloadFormat
enum<string>
obrigatório

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

Opções disponíveis:
reconstructed,
structured
Exemplo:

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