bLink API - platform module (2.0.15.4-six)

Download OpenAPI specification:Download

URL: https://www.six-group.com/en/products-services/banking-services/blink.html

This is the specification of the bLink 'platform' module API. (as implemented by SIX and used by clients (e.g. third party providers))

directory

participant information Information about participating parties. (SCOPE: SIX)

Retrieve a list of all registered clients (e.g., third party providers)

Returns a list of clients with information regarding software and supported use cases. (SCOPE: SIX)

query Parameters

status	string (Directory Participant Status) Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE" "SUSPENDED" "ONBOARDING_DEVELOPMENT" Example: status=ACTIVE Returns clients or providers with the corresponding status. Possible status: ACTIVE, ONBOARDING_DEVELOPMENT, INACTIVE, SUSPENDED Default value when no matching status is found: ACTIVE
embed_assets	string (Embed Asset Type) Default: "LOGO" Enum: "ALL" "NONE" "LOGO" Example: embed_assets=LOGO ALL = Embed all assets as base64 LOGO = Embed all logos as base64 NONE = No embedded assets Default value when no matching type is found: LOGO

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent required	string Name and version of the of the Client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type

application/json

[{"companyName": "ACME",
"contact": [{"type": "BUSINESS",
"designation": "Account and Payments Services",
"emailAddress": "business-contact@acme.com"
},
{"type": "TECHNICAL",
"emailAddress": "technical-contact@acme.com",
"phone": "+41 58 999 9999"
},
{"type": "SUPPORT",
"emailAddress": "support-contact@acme.com",
"phone": "+41 58 999 9997"
}
],
"companyLogo": {"small": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"large": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
}
},
"marketingImage": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"companyUrl": "https://www.acme.com",
"marketingDescription": {"de": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"en": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"fr": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"it": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
]
},
"shortDescription": {"de": "Kurzbeschreibung",
"en": "Short description",
"fr": "Description rapide",
"it": "Corta descrizione"
},
"status": "ACTIVE",
"registrationDate": "2018-04-13T11:11:11Z",
"lastModified": "2018-04-13T11:11:11Z",
"software": {"productName": {"de": "ACME Buchhaltungssoftware",
"en": "ACME accounting software",
"fr": "ACME software comptable",
"it": "ACME software contabilità"
},
"manufacturer": "ACME Corp.",
"category": ["ACCOUNTING"
],
"productInfoUrl": "https://acme.com/amce_accounting",
"productLogo": {"small": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"large": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
}
},
"marketingImage": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"marketingDescription": {"de": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"en": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"fr": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"it": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
]
},
"shortDescription": {"de": "Kurzbeschreibung",
"en": "Short description",
"fr": "Description rapide",
"it": "Corta descrizione"
}
},
"useCases": [{"name": "ais",
"version": "v1",
"status": "CERTIFIED",
"from": "2018-04-13T11:11:11Z",
"until": "2018-04-13T11:11:11Z",
"scopes": "urn:blink:ow:custmgmt urn:blink:ow:custmgmt:write",
"properties": {"property1": "string",
"property2": "string"
},
"endpointInfos": [{"name": "clientConsentBackendUrl",
"url": "https://www.acme.com/consent"
}
]
}
],
"consentFlows": [{"type": "consent-flow-v2",
"version": "v1",
"status": "CERTIFIED",
"from": "2019-08-24T14:15:22Z",
"until": "2018-04-13T11:11:11Z",
"endpointInfos": [{"name": "clientConsentBackendUrl",
"url": "https://www.acme.com/consent"
}
]
}
],
"features": {"property1": "string",
"property2": "string"
},
"clientId": 1234
}
]

Retrieve the information for a registered client (e.g. third party provider)

Returns information regarding software and supported use cases of a client. (SCOPE: SIX)

path Parameters

clientId

required

string <= 30 characters

id of the client

query Parameters

embed_assets

string (Embed Asset Type)

Default: "LOGO"

Enum: "ALL" "NONE" "LOGO"

Example: embed_assets=LOGO

ALL = Embed all assets as base64 LOGO = Embed all logos as base64 NONE = No embedded assets Default value when no matching type is found: LOGO

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent required	string Name and version of the of the Client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type

application/json

{"companyName": "ACME",
"contact": [{"type": "BUSINESS",
"designation": "Account and Payments Services",
"emailAddress": "business-contact@acme.com"
},
{"type": "TECHNICAL",
"emailAddress": "technical-contact@acme.com",
"phone": "+41 58 999 9999"
},
{"type": "SUPPORT",
"emailAddress": "support-contact@acme.com",
"phone": "+41 58 999 9997"
}
],
"companyLogo": {"small": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"large": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
}
},
"marketingImage": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"companyUrl": "https://www.acme.com",
"marketingDescription": {"de": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"en": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"fr": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"it": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
]
},
"shortDescription": {"de": "Kurzbeschreibung",
"en": "Short description",
"fr": "Description rapide",
"it": "Corta descrizione"
},
"status": "ACTIVE",
"registrationDate": "2018-04-13T11:11:11Z",
"lastModified": "2018-04-13T11:11:11Z",
"software": {"productName": {"de": "ACME Buchhaltungssoftware",
"en": "ACME accounting software",
"fr": "ACME software comptable",
"it": "ACME software contabilità"
},
"manufacturer": "ACME Corp.",
"category": ["ACCOUNTING"
],
"productInfoUrl": "https://acme.com/amce_accounting",
"productLogo": {"small": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"large": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
}
},
"marketingImage": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"marketingDescription": {"de": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"en": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"fr": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"it": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
]
},
"shortDescription": {"de": "Kurzbeschreibung",
"en": "Short description",
"fr": "Description rapide",
"it": "Corta descrizione"
}
},
"useCases": [{"name": "ais",
"version": "v1",
"status": "CERTIFIED",
"from": "2018-04-13T11:11:11Z",
"until": "2018-04-13T11:11:11Z",
"scopes": "urn:blink:ow:custmgmt urn:blink:ow:custmgmt:write",
"properties": {"property1": "string",
"property2": "string"
},
"endpointInfos": [{"name": "clientConsentBackendUrl",
"url": "https://www.acme.com/consent"
}
]
}
],
"consentFlows": [{"type": "consent-flow-v2",
"version": "v1",
"status": "CERTIFIED",
"from": "2019-08-24T14:15:22Z",
"until": "2018-04-13T11:11:11Z",
"endpointInfos": [{"name": "clientConsentBackendUrl",
"url": "https://www.acme.com/consent"
}
]
}
],
"features": {"property1": "string",
"property2": "string"
},
"clientId": 1234
}

Retrieve a list of all registered providers (e.g., financial institutions)

Returns a list of providers with information regarding software and supported use cases. (SCOPE: SIX)

query Parameters

status	string (Directory Participant Status) Default: "ACTIVE" Enum: "ACTIVE" "INACTIVE" "SUSPENDED" "ONBOARDING_DEVELOPMENT" Example: status=ACTIVE Returns clients or providers with the corresponding status. Possible status: ACTIVE, ONBOARDING_DEVELOPMENT, INACTIVE, SUSPENDED Default value when no matching status is found: ACTIVE
embed_assets	string (Embed Asset Type) Default: "LOGO" Enum: "ALL" "NONE" "LOGO" Example: embed_assets=LOGO ALL = Embed all assets as base64 LOGO = Embed all logos as base64 NONE = No embedded assets Default value when no matching type is found: LOGO

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent required	string Name and version of the of the Client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type

application/json

[{"companyName": "ACME",
"contact": [{"type": "BUSINESS",
"designation": "Account and Payments Services",
"emailAddress": "business-contact@acme.com"
},
{"type": "TECHNICAL",
"emailAddress": "technical-contact@acme.com",
"phone": "+41 58 999 9999"
},
{"type": "SUPPORT",
"emailAddress": "support-contact@acme.com",
"phone": "+41 58 999 9997"
}
],
"companyLogo": {"small": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"large": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
}
},
"marketingImage": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"companyUrl": "https://www.acme.com",
"marketingDescription": {"de": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"en": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"fr": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"it": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
]
},
"shortDescription": {"de": "Kurzbeschreibung",
"en": "Short description",
"fr": "Description rapide",
"it": "Corta descrizione"
},
"status": "ACTIVE",
"registrationDate": "2018-04-13T11:11:11Z",
"lastModified": "2018-04-13T11:11:11Z",
"software": {"productName": {"de": "ACME Buchhaltungssoftware",
"en": "ACME accounting software",
"fr": "ACME software comptable",
"it": "ACME software contabilità"
},
"manufacturer": "ACME Corp.",
"category": ["ACCOUNTING"
],
"productInfoUrl": "https://acme.com/amce_accounting",
"productLogo": {"small": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"large": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
}
},
"marketingImage": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"marketingDescription": {"de": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"en": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"fr": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"it": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
]
},
"shortDescription": {"de": "Kurzbeschreibung",
"en": "Short description",
"fr": "Description rapide",
"it": "Corta descrizione"
}
},
"useCases": [{"name": "ais",
"version": "v1",
"status": "CERTIFIED",
"from": "2018-04-13T11:11:11Z",
"until": "2018-04-13T11:11:11Z",
"scopes": "urn:blink:ow:custmgmt urn:blink:ow:custmgmt:write",
"properties": {"property1": "string",
"property2": "string"
},
"endpointInfos": [{"name": "clientConsentBackendUrl",
"url": "https://www.acme.com/consent"
}
]
}
],
"consentFlows": [{"type": "consent-flow-v2",
"version": "v1",
"status": "CERTIFIED",
"from": "2019-08-24T14:15:22Z",
"until": "2018-04-13T11:11:11Z",
"endpointInfos": [{"name": "clientConsentBackendUrl",
"url": "https://www.acme.com/consent"
}
]
}
],
"features": {"property1": "string",
"property2": "string"
},
"providerId": 1234
}
]

Retrieve the informatoin for a registered provider (e.g., financial institutions)

Returns information regarding software and supported use cases of a provider. (SCOPE: SIX)

path Parameters

providerId

required

string <= 30 characters

id of the provider

query Parameters

embed_assets

string (Embed Asset Type)

Default: "LOGO"

Enum: "ALL" "NONE" "LOGO"

Example: embed_assets=LOGO

ALL = Embed all assets as base64 LOGO = Embed all logos as base64 NONE = No embedded assets Default value when no matching type is found: LOGO

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent required	string Name and version of the of the Client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type

application/json

{"companyName": "ACME",
"contact": [{"type": "BUSINESS",
"designation": "Account and Payments Services",
"emailAddress": "business-contact@acme.com"
},
{"type": "TECHNICAL",
"emailAddress": "technical-contact@acme.com",
"phone": "+41 58 999 9999"
},
{"type": "SUPPORT",
"emailAddress": "support-contact@acme.com",
"phone": "+41 58 999 9997"
}
],
"companyLogo": {"small": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"large": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
}
},
"marketingImage": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"companyUrl": "https://www.acme.com",
"marketingDescription": {"de": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"en": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"fr": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"it": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
]
},
"shortDescription": {"de": "Kurzbeschreibung",
"en": "Short description",
"fr": "Description rapide",
"it": "Corta descrizione"
},
"status": "ACTIVE",
"registrationDate": "2018-04-13T11:11:11Z",
"lastModified": "2018-04-13T11:11:11Z",
"software": {"productName": {"de": "ACME Buchhaltungssoftware",
"en": "ACME accounting software",
"fr": "ACME software comptable",
"it": "ACME software contabilità"
},
"manufacturer": "ACME Corp.",
"category": ["ACCOUNTING"
],
"productInfoUrl": "https://acme.com/amce_accounting",
"productLogo": {"small": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"large": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
}
},
"marketingImage": {"mimeType": "image/svg+xml",
"image": "QUNNRQ==",
"assetId": "assetId.svg"
},
"marketingDescription": {"de": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"en": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"fr": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
],
"it": ["bullet1",
"bullet2",
"bullet3",
"bullet4",
"bullet5"
]
},
"shortDescription": {"de": "Kurzbeschreibung",
"en": "Short description",
"fr": "Description rapide",
"it": "Corta descrizione"
}
},
"useCases": [{"name": "ais",
"version": "v1",
"status": "CERTIFIED",
"from": "2018-04-13T11:11:11Z",
"until": "2018-04-13T11:11:11Z",
"scopes": "urn:blink:ow:custmgmt urn:blink:ow:custmgmt:write",
"properties": {"property1": "string",
"property2": "string"
},
"endpointInfos": [{"name": "clientConsentBackendUrl",
"url": "https://www.acme.com/consent"
}
]
}
],
"consentFlows": [{"type": "consent-flow-v2",
"version": "v1",
"status": "CERTIFIED",
"from": "2019-08-24T14:15:22Z",
"until": "2018-04-13T11:11:11Z",
"endpointInfos": [{"name": "clientConsentBackendUrl",
"url": "https://www.acme.com/consent"
}
]
}
],
"features": {"property1": "string",
"property2": "string"
},
"providerId": 1234
}

Retrieve assets for participants

Returns logo- and marketing images/assets for a participant (SCOPE: SIX)

path Parameters

assetId

required

string <= 36 characters

id of assetId

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent required	string Name and version of the of the Client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type

application/problem+json

{"type": "/problems/TECHNICAL_ERROR",
"title": "This is the general problem description",
"detail": "Detailed problem description with respect to the current request, e.g., invalid account number format",
"instance": "path/to/corresponding/resource"
}

asset

Retrieve assets for participants

Returns logo- and marketing images/assets for a participant (SCOPE: SIX)

path Parameters

assetId

required

string <= 36 characters

id of assetId

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent required	string Name and version of the of the Client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type

application/problem+json

{"type": "/problems/TECHNICAL_ERROR",
"title": "This is the general problem description",
"detail": "Detailed problem description with respect to the current request, e.g., invalid account number format",
"instance": "path/to/corresponding/resource"
}

image

Retrieve assets for participants

Returns logo- and marketing images/assets for a participant (SCOPE: SIX)

path Parameters

assetId

required

string <= 36 characters

id of assetId

header Parameters

X-Correlation-ID required	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent required	string Name and version of the of the Client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

Content type

application/problem+json

{"type": "/problems/TECHNICAL_ERROR",
"title": "This is the general problem description",
"detail": "Detailed problem description with respect to the current request, e.g., invalid account number format",
"instance": "path/to/corresponding/resource"
}

diagnostics

Returns all specified request headers and additional diagnostic information

header Parameters

X-Correlation-ID	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent	string Name and version of the of the client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

200

Content type

application/json

{"requestDateTime": "2018-04-13T11:11:11Z",
"receivedHeaders": [{"headerName": "X-Correlation-ID",
"headerValue": "string"
}
],
"receivedPayload": "... as received ..."
}

Returns all specified request headers, the request body and additional diagnostic information

header Parameters

X-Correlation-ID	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent	string Name and version of the of the client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

200

Content type

application/json

{"requestDateTime": "2018-04-13T11:11:11Z",
"receivedHeaders": [{"headerName": "X-Correlation-ID",
"headerValue": "string"
}
],
"receivedPayload": "... as received ..."
}

routinginstructions

Returns instructed routes for service user to service provider communication

header Parameters

X-Correlation-ID	string <= 64 characters Unique ID (defined by the caller) which will be reflected back in the response.
User-Agent	string Name and version of the of the client software
X-Instance-ID	string <= 64 characters (Deprecated) Identifies an on-prem application instance which uses a legacy on-prem certificate in the mTLS connection. Do not use the header otherwise.

Responses

Response samples

200

Content type

application/json

{"requestDateTime": "2018-04-13T11:11:11Z",
"message": "string",
"instructedRoutingTargets": ["string"
]
}

bLink API - platform module (2.0.15.4-six)

directory

Retrieve a list of all registered clients (e.g., third party providers)

query Parameters

header Parameters

Responses

Response samples

Retrieve the information for a registered client (e.g. third party provider)

path Parameters

query Parameters

header Parameters

Responses

Response samples

Retrieve a list of all registered providers (e.g., financial institutions)

query Parameters

header Parameters

Responses

Response samples

Retrieve the informatoin for a registered provider (e.g., financial institutions)

path Parameters

query Parameters

header Parameters

Responses

Response samples

Retrieve assets for participants

path Parameters

header Parameters

Responses

Response samples

asset

Retrieve assets for participants

path Parameters

header Parameters

Responses

Response samples

image

Retrieve assets for participants

path Parameters

header Parameters

Responses

Response samples

diagnostics

Returns all specified request headers and additional diagnostic information

header Parameters

Responses

Response samples

Returns all specified request headers, the request body and additional diagnostic information

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

routinginstructions

Returns instructed routes for service user to service provider communication

header Parameters

Responses

Response samples

Request Body schema: application/json
required