Updates an existing api family

PUT /references/apifamilies/{ApiFamilyID}

O auth

Headers

x-fapi-auth-date string

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Format should match the following pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$.
x-fapi-customer-ip-address string

The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id string

An RFC4122 UID used as a correlation id.
x-customer-user-agent string

Indicates the user-agent that the PSU is using.

Path parameters

ApiFamilyID string(uuid) Required

The ID of the api family to target

application/json

Body

Cascade boolean Required

If set to true on an operation that would deactivate the resource, all references to this given resource in other resources will be removed

Default value is false.
Status string Required

Current status of this resource

Values are Active or Inactive. Default value is Active.
CertificationURIRegex string

regex to validate the cerfification URI

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
ConformanceTest boolean Required

Whether the conformance testing is required/enabled
DeprecationDate string(date)

Api family support/deprecation end date
Endpoints array[string] Required

List of regexes (as strings) that valid endpoint URLs must match
Mandatory boolean Required

Whether implementing this API family is mandatory
MetadataSchema object

Raw JSON object containing an OpenAPI Schema definition for the metadata.

Additional properties are allowed.
Name string Required

The name of the api family

Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
RequiresWellKnown boolean Required
StartDate string(date)

Api family start date
Version string Required

Semantic version of this configuration.

Responses

200 application/json

Response with for a single api family
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
Hide response attributes Show response attributes object
- CreatedAt string(date-time)
- Id string(uuid)
  
  Unique ID of the api family
- Status string
  
  Current status of this resource
  
  Values are Active or Inactive. Default value is Active.
- UpdatedAt string(date-time)
- CertificationURIRegex string
  
  regex to validate the cerfification URI
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- ConformanceTest boolean Required
  
  Whether the conformance testing is required/enabled
- DeprecationDate string(date)
  
  Api family support/deprecation end date
- Endpoints array[string] Required
  
  List of regexes (as strings) that valid endpoint URLs must match
- Mandatory boolean Required
  
  Whether implementing this API family is mandatory
- MetadataSchema object
  
  Raw JSON object containing an OpenAPI Schema definition for the metadata.
  
  Additional properties are allowed.
- Name string Required
  
  The name of the api family
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- RequiresWellKnown boolean Required
- StartDate string(date)
  
  Api family start date
- Version string Required
  
  Semantic version of this configuration.
400 application/json

Bad Request
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
Hide response attribute Show response attribute object
- errors array[string]
  
  Validation Error messages
401

Unauthorized
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
403

Forbidden
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
409

Conflict
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
429

Too many requests, maximum capacity reached. Requests are now throttled.
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
500

Internal Server Error
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
502

Bad Gateway
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
504

Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

PUT /references/apifamilies/{ApiFamilyID}

curl \
 --request PUT 'https://matls-api.sandbox.raidiam.io/references/apifamilies/f81d4fae-7dec-11d0-a765-00a0c91e6bf6' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "x-fapi-auth-date: string" \
 --header "x-fapi-customer-ip-address: string" \
 --header "x-fapi-interaction-id: string" \
 --header "x-customer-user-agent: string" \
 --data '{"Cascade":false,"Status":"Active","CertificationURIRegex":"string","ConformanceTest":true,"DeprecationDate":"2021-01-30","Endpoints":["^(https:\\/\\/)(.*?)(\\/open-banking\\/admin\\/v\\d+\\/metrics)$"],"Mandatory":true,"MetadataSchema":{},"Name":"string","RequiresWellKnown":true,"StartDate":"2021-01-30","Version":"2.0.0"}'

Request examples

# Headers
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-fapi-interaction-id: string
x-customer-user-agent: string

# Payload
{
  "Cascade": false,
  "Status": "Active",
  "CertificationURIRegex": "string",
  "ConformanceTest": true,
  "DeprecationDate": "2021-01-30",
  "Endpoints": [
    "^(https:\\/\\/)(.*?)(\\/open-banking\\/admin\\/v\\d+\\/metrics)$"
  ],
  "Mandatory": true,
  "MetadataSchema": {},
  "Name": "string",
  "RequiresWellKnown": true,
  "StartDate": "2021-01-30",
  "Version": "2.0.0"
}

Response examples (200)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "CreatedAt": "2025-05-04T09:42:00Z",
  "Id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "Status": "Active",
  "UpdatedAt": "2025-05-04T09:42:00Z",
  "CertificationURIRegex": "string",
  "ConformanceTest": true,
  "DeprecationDate": "2021-01-30",
  "Endpoints": [
    "^(https:\\/\\/)(.*?)(\\/open-banking\\/admin\\/v\\d+\\/metrics)$"
  ],
  "Mandatory": true,
  "MetadataSchema": {},
  "Name": "string",
  "RequiresWellKnown": true,
  "StartDate": "2021-01-30",
  "Version": "2.0.0"
}

Response examples (400)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}