NAV Navbar

Get Software Statement Assertion (SSA) V1

This page documents the obsolete version 1 of the Get Software Statement Assertion (SSA) end point.

The authorisation scopes returned in v1 and v2 of the Get Software Statement Assertion endpoint are explicitly defined as follows:

GetSSA Version Categories returned Authorisation Scopes returned in SSA
v1 & v2 OIDC
Banking
Common
Registration
profile
openid

bank:accounts.basic:read
bank:accounts.detail:read
bank:transactions:read
bank:payees:read
bank:regular_payments:read

common:customer.basic:read
common:customer.detail:read

cdr:registration

GetSoftwareStatementAssertion (SSA)

Get a Software Statement Assertion (SSA) for a software product on the CDR Register to be used for Dynamic Registration with a Data Holder

Endpoint Version

Version 1

Code samples

GET https://<register-base-url>/cdr-register/v1/{industry}/data-recipients/brands/{dataRecipientBrandId}/software-products/{softwareProductId}/ssa HTTP/1.1
Host: <register-base-url>
Accept: application/json
Authorization: Bearer <access-token>
x-v: string

GET /{industry}/data-recipients/brands/{dataRecipientBrandId}/software-products/{softwareProductId}/ssa

Parameters

Name In Type Required Description
industry path string true The industry the participant is retrieving data for (Banking, etc)
dataRecipientBrandId path string true Unique id for the Accredited Data Recipient Brand that the Software Product is associated with in the CDR Register
softwareProductId path string true Unique id for the Accredited Data Recipient Software Product in the CDR Register
Authorization header string true An Authorisation Token as per RFC6750
x-v header string false none

Enumerated Values

Parameter Value
industry banking

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request ResponseErrorList
401 Unauthorized Unauthorized None
403 Forbidden Forbidden ResponseErrorList
406 Not Acceptable Not Acceptable None

ResponseErrorList

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": {}
    }
  ]
}

Properties

Name Type Required Restrictions Description
errors [Error] true none none

Error

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "meta": {}
}

Properties

Name Type Required Restrictions Description
code string true none Error code
title string true none Error title
detail string true none Error detail
meta object false none Optional additional data for specific error types