Skip to main content
GET
Read the outcome of an IF Domicílio connectivity test

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

participantIspb
string
required

Participant ISPB (8 characters, digits or uppercase letters).

Example:

"12345678"

testId
string
required

Test id the POST returned.

Example:

"0f8fad5b-d9cb-469f-a165-70867728950e"

Response

OK

msgEco
string
required

Echo token sent in the AGEN001.

Example:

"SLC-ECO-0f8fad5bd9cb469fa16570867728950e"

participantId
string
required

Participant id (8-character ISPB).

Example:

"12345678"

sentAt
string
required

When the AGEN001 was sent (RFC3339 UTC).

Example:

"2026-05-28T10:00:00Z"

status
enum<string>
required

PENDING: sent, no answer yet. ANSWERED: Núclea returned the AGEN001RET. REFUSED: Núclea answered with an ERR. NO_ANSWER: no RET or ERR within the answer bound.

Available options:
PENDING,
ANSWERED,
REFUSED,
NO_ANSWER
Example:

"ANSWERED"

testId
string
required

Test id returned by the POST.

Example:

"0f8fad5b-d9cb-469f-a165-70867728950e"

answeredAt
string

When the answer was read (RFC3339 UTC); present once answered or refused.

Example:

"2026-05-28T10:00:20Z"

echoMatches
boolean

Whether the answer echoed the token that was sent; present once answered.

Example:

true

echoedMsgEco
string

Echo token the AGEN001RET carried; present once answered.

Example:

"SLC-ECO-0f8fad5bd9cb469fa16570867728950e"

errorCode
string

CodErro of the ERR; present when refused.

Example:

"ESLC0118"

latencyMs
integer<int64>

Milliseconds from send to the answer being read; present once answered.

Example:

20000