KYC
The KYC Service allows you to verify your PSUs before they can initiate payments. KYC is completed via redirection to Open Payments' hosted flow, where the PSU can submit required identity and verification data. Creating a new KYC process on an organization generates a URL to the KYC webform, which is accessible for 30 minutes. If more time is needed, a new URL will have to be generated. This guide shows you how to initiate a KYC process.
For requests to the KYC Service API, you need an access token with scope set to paymentinitiation corporate.
1. Create KYC
Endpoint
POST /integration/v1/new/{PSU-Corporate-ID}httpPath Parameter
| Name | Type | Description |
|---|---|---|
PSU-Corporate-ID | string | The Corporate ID of the PSU when acting on behalf of an organization, e.g. Org. nummer for SE, KVK for NL. |
Query Parameter
| Name | Type | Description |
|---|---|---|
countryCode | string | ISO country code for the country of the organization. |
Request Headers
| Name | Type | Description |
|---|---|---|
X-Request-ID | string(uuid) | The ID of the request, unique to the call, as determined by the initiating party. |
curl -X POST "https://api.openbankingplatform.com/integration/v1/new/1234567890?countryCode=SE" \ -H "X-Request-ID: ce3bf611-71d5-44c6-bfbe-78a48ecdda96"bash
Response
{
"kycUrl": "https://kyc.openbankingplatform.com/form/?instanceId=070a4c80-ceca-4964-8003-1e20b94ef710"
}jsonThe URL in the response directs the PSU to the webform, where they will be guided through the KYC process.
2. Get KYC Status
Once the form is submitted, you can check if the KYC was successful by making the following request.
Endpoint
GET /integration/v1/status/{PSU-Corporate-ID}httpPath Parameter
| Name | Type | Description |
|---|---|---|
PSU-Corporate-ID | string | The Corporate ID of the PSU when acting on behalf of an organization, e.g. Org. nummer for SE, KVK for NL. |
Request Headers
| Name | Type | Description |
|---|---|---|
X-Request-ID | string(uuid) | The ID of the request, unique to the call, as determined by the initiating party. |
curl -X GET "https://api.openbankingplatform.com/integration/v1/status/1234567890" \ -H "X-Request-ID: fc29ef1a-705d-43ed-9785-773d29408881"bash
Response
{
"psuCorporateId": "1234567890",
"kycStatus": "Valid",
"kycValidUntil": "2026-05-19"
}jsonWhen the kycStatus is Valid, the organization can start making payments.