--- updatedAt: 2026-03-25T11:20:16.000Z --- # Read the SCA status of the consent authorisation This method returns the SCA status of a consent initiation's authorisation sub-resource. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "OpenBanking Service For Loans and Savings", "description": "APIs for getting user consent on subject such as Account Information Services (AIS), Client Information and etc.\n\nThe result of this process is a consent resource. A link to this resource is returned to the AISP within this process.\nThe TPP can retrieve the consent object by submitting a GET method on this resource.\nThis object contains the detailed access rights, the current validity and a Consent-ID token. \n\nAbbreviations used in the documentation:\n * TPP - Third Party Providers\n * AIS - Account Information Service\n * ASPSP - Account Servicing Payment Service Provider \n * PSU - Payment Service User\n * SCA - Strong Customer Authentication\n\nIn order to make test integration, please use https://test-openbanking.tbcbank.ge\n", "version": "1.0" }, "servers": [ { "url": "https://test-api.tbcbank.ge/xs2a-sandbox" }, { "url": "https://test-openbanking.tbcbank.ge" }, { "url": "https://openbanking.tbcbank.ge" } ], "paths": { "/v2/consents/account-access/{consentId}/authorisations/{authorisationId}": { "get": { "summary": "Read the SCA status of the consent authorisation", "description": "This method returns the SCA status of a consent initiation's authorisation sub-resource.", "tags": [ "Consent" ], "security": [ { "BearerAuthOAuth": [] } ], "parameters": [ { "$ref": "#/components/parameters/ConsentId" }, { "$ref": "#/components/parameters/AuthorisationId" }, { "$ref": "#/components/parameters/X-Request-ID" }, { "$ref": "#/components/parameters/Digest" }, { "$ref": "#/components/parameters/Signature" }, { "$ref": "#/components/parameters/PSU-IP-Address" }, { "$ref": "#/components/parameters/Accept-Language" }, { "$ref": "#/components/parameters/PSU-IP-Port" }, { "$ref": "#/components/parameters/PSU-Geo-Location" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorisationStatusResponse" }, "examples": { "Response on Get Consent Authorisation status request": { "$ref": "#/components/examples/AuthorisationStatusResponse_Example" } } } } }, "400": { "description": "Bad Request", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ApiProblemDetails" }, "example": { "code": "FORMAT_ERROR", "traceId": "00-93d709e20137ab47f7fd67e2580be85e-8d30930a9025e553-01", "type": "https://developers.tbcbank.ge/docs/error-type-400", "title": "Invalid ConsentId", "status": 400, "detail": "ConsentId is not valid Guid: 123", "instance": "/v1/consents/123/authorisations/cc247cea-edea-40d5-aa24-581e1f6be7e5" } } } }, "401": { "description": "Unauthorized", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ApiProblemDetails" }, "example": { "type": "https://developers.tbcbank.ge/docs/error-type-401", "title": "Access Token is expired.", "status": 401, "detail": "Access Token is expired.", "systemCode": "System code for problem is System code for problem is psd2_accounts-0.8.401.TOKEN_EXPIRED", "code": "TOKEN_EXPIRED", "traceId": "rrt-04053ba3aa8013db2-a-de-14879-4916302-1", "instance": "/v1/consents/69a3d6a8-e7fe-4de0-904b-27eab5d33366/authorisations/cc247cea-edea-40d5-aa24-581e1f6be7e5" } } } }, "403": { "description": "Forbidden", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ApiProblemDetails" }, "example": { "code": "CONSENT_UNKNOWN", "traceId": "00-52c9017a1ce75790a168d47ee41b9ad0-fbc6a16cfc2769ff-01", "type": "https://developers.tbcbank.ge/docs/error-type-403", "title": "Consent not found", "status": 403, "detail": "Consent not found with this Id: 69a3d6a8-e7fe-4de0-904b-27eab5d33366", "instance": "/v1/consents/69a3d6a8-e7fe-4de0-904b-27eab5d33366/authorisations/cc247cea-edea-40d5-aa24-581e1f6be7e5" } } } }, "500": { "description": "Server Error", "headers": { "X-Request-ID": { "$ref": "#/components/headers/X-Request-ID" } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ApiProblemDetails" }, "example": { "code": "", "traceId": "00-ada2ec0e2c26c91bf50469bf79fdb14e-7bed7bf0dd005c16-01", "type": "https://developers.tbcbank.ge/docs/error-type-500", "title": "Internal Error", "status": 500, "detail": "Something wrong happened in the application", "instance": "/v1/consents/69a3d6a8-e7fe-4de0-904b-27eab5d33366/authorisations/cc247cea-edea-40d5-aa24-581e1f6be7e5" } } } } } } } }, "components": { "headers": { "X-Request-ID": { "description": "ID of the request, unique to the call, as determined by the initiating party.", "required": true, "example": "dca140c0-7db3-4cf3-9415-81b5a141f5f3", "schema": { "type": "string", "format": "uuid" } } }, "parameters": { "ConsentId": { "description": "ID of the corresponding consent object as returned by an account information consent request.\n", "name": "consentId", "in": "path", "required": true, "schema": { "type": "string" } }, "AuthorisationId": { "name": "authorisationId", "in": "path", "description": "Resource identification of the related SCA.", "required": true, "schema": { "type": "string" } }, "X-Request-ID": { "name": "X-Request-ID", "in": "header", "description": "ID of the request, unique to the call, as determined by the initiating party.", "required": true, "example": "dca140c0-7db3-4cf3-9415-81b5a141f5f3", "schema": { "type": "string", "format": "uuid" } }, "Digest": { "name": "Digest", "in": "header", "description": "Is contained if and only if the \"Signature\" element is contained in the header of the request.", "required": true, "example": "SHA-256=+cHUU0wsuM/h13R5ler2wULmkj+gN3XAuUww3SbbAdM=", "schema": { "type": "string" } }, "Signature": { "name": "X-JWS-Signature", "in": "header", "description": "A signature of the request by the TPP on application level. This might be mandated by ASPSP.", "required": true, "schema": { "type": "string" } }, "PSU-IP-Address": { "name": "PSU-IP-Address", "in": "header", "description": "The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.", "required": true, "example": "123.345.567.78", "schema": { "type": "string", "format": "ipv4 or ipv6" } }, "Accept-Language": { "name": "Accept-Language", "in": "header", "description": "HTTP header indicates the natural language and locale that the client prefers.", "example": "ka", "schema": { "type": "string" } }, "PSU-IP-Port": { "name": "PSU-IP-Port", "in": "header", "description": "The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.", "example": "1234", "schema": { "type": "string" } }, "PSU-Geo-Location": { "name": "PSU-Geo-Location", "in": "header", "description": "The forwarded Geo Location of the corresponding http request between PSU and TPP if available.", "example": "GEO:42.00;43.50", "schema": { "type": "string" } } }, "schemas": { "AuthorisationStatusResponse": { "description": "Body of the response for a successfull get authorisation status request.", "type": "object", "properties": { "scaStatus": { "$ref": "#/components/schemas/ScaStatus" } } }, "ApiProblemDetails": { "description": "A machine-readable format for specifying errors in HTTP API responses.", "type": "object", "properties": { "type": { "description": "A URI reference [RFC3986] that identifies the problem type.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type.", "type": "string" }, "status": { "description": "The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.", "type": "integer", "format": "int32" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": "string" }, "traceId": { "description": "Message identification for searching errors", "type": "string" }, "code": { "type": "string", "description": "Message codes defined for AIS for appropriate HTTP status code" } } }, "ScaStatus": { "description": "This data element is containing information about the status of the SCA method applied. \n\nThe following codes are defined for this data type.\n\n * 'received':\n An authorisation or cancellation-authorisation resource has been created successfully.\n * 'psuIdentified':\n The PSU related to the authorisation or cancellation-authorisation resource has been identified.\n * 'psuAuthenticated':\n The PSU related to the authorisation or cancellation-authorisation resource has been identified and authenticated e.g. by a password or by an access token.\n * 'scaMethodSelected':\n The PSU/TPP has selected the related SCA routine. \n If the SCA method is chosen implicitly since only one SCA method is available, \n then this is the first status to be reported instead of 'received'.\n * 'unconfirmed':\n SCA is technically successfully finalised by the PSU, but the authorisation resource needs a confirmation command by the TPP yet. \n * 'started':\n The addressed SCA routine has been started.\n * 'finalised':\n The SCA routine has been finalised successfully (including a potential confirmation command). \n This is a final status of the authorisation resource.\n * 'failed':\n The SCA routine failed.\n This is a final status of the authorisation resource.\n * 'exempted':\n SCA was exempted for the related transaction, the related authorisation is successful.\n This is a final status of the authorisation resource.\n", "type": "string", "enum": [ "received", "psuIdentified", "psuAuthenticated", "scaMethodSelected", "started", "unconfirmed", "finalised", "failed", "exempted" ] } }, "securitySchemes": { "BearerAuthOAuth": { "description": "Bearer Token. \n\nIs contained only, if an OAuth2 based authentication was performed in a pre-step or \nan OAuth2 based SCA was performed in a preceding AIS service in the same session.\n", "type": "http", "scheme": "bearer" } }, "examples": { "AuthorisationStatusResponse_Example": { "description": "Response on Get Consent Authorisation status request.", "value": { "scaStatus": "scaMethodSelected" } } } }, "security": [ {} ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```