Test BACEN STA connectivity for a credential

Runs a BACEN STA connectivity probe for the credential and returns the outcome, latency, and diagnostic message.

POST /v1/credentials/{id}/test

Test BACEN STA connectivity for a credential

cURL

curl --request POST \
  --url https://sta.sandbox.lerian.net/v1/credentials/{id}/test \
  --header 'Authorization: Bearer <token>'

200

{
  "credentialId": "<string>",
  "message": "<string>",
  "responseTimeMs": 123,
  "result": "<string>",
  "testedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Credential UUID

Example:

"018f3b2a-0c1d-7a2b-9e4f-1a2b3c4d5e6f"

Response

200

application/json

OK

credentialId · string · required

message · string · required

responseTimeMs · integer<int64> · required

result · string · required

testedAt · string<date-time> · required