Skip to content
YutaiDocs
GET /v1/statusGet API key

API reference / API reference

Read a Connect session

One call of the distributor API, read from the interface description Yutai publishes. Every sample answer on this page is simulated: no real holder's data stands behind it. The formats every value travels in are the identifiers page's.

View as .md

The call

GET/v1/connect/sessions/{id}Callable today

The key presents the connect.read scope.

The parameters

id
Required. The Connect session's own id, the one the create answer carried. It sits in the call's address.

What it answers

The session's standing - pending, opened, connected, cancelled, failed or expired - the distributor's own reference, when it was created and when it ended, and the one reason a failed session carries. A session still open carries no completion and no reason; a session no one opened before its token ran out reads expired.

  • id

    Required. A string.

  • status

    Required. A string that is one of the values below.

    • pending
    • opened
    • connected
    • cancelled
    • failed
    • expired

  • externalRef

    Required. A string.

  • createdAt

    Required. An instant in the ISO 8601 form.

  • completedAt

    Required. An instant in the ISO 8601 form. It may also be null.

  • failureReason

    Required. A string that is one of the values below. It may also be null.

    • consent_declined
    • bank_unavailable
    • country_not_supported

The errors

Every refused call answers one object with one field, message: the plain sentence that says what did not happen. The sentence carries 1 to 512 characters, so a refusal never carries an id, a code or an exception's text.

The errors the call for GET /v1/connect/sessions/{id} answers
StatusWhat it answers
401The key is missing, malformed, unknown, revoked or expired.
403The key does not carry the scope. The call is also refused with 403, nothing read, when the distributor is paused, suspended or closed, when the key is paused, or when the key presents from an origin it does not allow.
404No Connect session answers this id under this distributor's key: an unknown id, a malformed id, or one another distributor's key created. The answer is the same for both, so no session id can be probed.
429The key made too many calls this minute. The Retry-After header names the seconds until the next window opens. Nothing was read.
500The read failed inside Yutai. Nothing was changed.