If you are a current SWIFT KYC Registry customer, you may be assigned the kyc-developer role and you will see KYC Registry API in the product list, please check the box and provide an application name and click Create App.
If you have the default developer role in your profile, you will instead see the option to select the KYC Registry API (lіmited) with partial API response samples in the product list. Interested to see the full API samples? Contact developer-support@swift.com to request kyc-developer role.
KYC Registry API uses token base authentication in sandbox and live. Retrieve consumer-key and consumer-secret from the app you created and use the OAuth API to generate a token.
Sandbox OAuth URL:
https://sandbox.swift.com/oauth2/v1/token
Use the hardcoded value for your credentials to generate a valid token (only in sandbox):
- 'username' (request body) =
sandbox-id - 'password' (request body) =
sandbox-key
KYC Registry API: https://sandbox.swift.com/kycr/v[x]
KYC Registry API (lіmited): https://sandbox.swift.com/kyc/v1
Sandbox Scenarios
-
Access Request API
Set My entity BIC to AAAABBCCXXX
Set Counterparty BIC to BKCHCATTXXX
-
All Entities Listing API
Retrieves entities in a paginated manner that matches the search criteria as given below.
- Set joined-since date as ‘2019-09-01’
- Set joined-since date as ‘2019-12-01’ & last-published-since date as ‘2020-01-01’
- Set joined-since date as ‘2019-12-01’ & lіmit as 10 with range of offset values as 0,10 and 20
- Set joined-since date as ‘2019-12-01’ & last-published-since date as ‘2020-01-01’ &lіmit as 10 with range of offset values as 0,10 and 20
|
Scenarios for Offset and lіmit |
Possible Outcomes |
|
When no Offset or lіmit value is given |
Then it will list 5 pages from record 1 onwards with default 10 records per page |
|
When Offset value is 0 and lіmit 10 is given |
It will list the first page with first 10 records |
|
When Offset value is 10 and lіmit 10 is given |
It will list the second page with next 10 records |
|
When Offset value is 20 and lіmit 10 is given |
It will list the last page with last 5 records |
|
When Offset value is 0 and lіmit 5 is given |
It will list the first page with first 5 records |
|
When Offset value is 5 and lіmit 5 is given |
It will list from record 5th onwards |
|
When Offset value is 10 and lіmit 5 is given |
It will list the second page with next 5 records |
|
When Offset value other than 0,10,20 given |
Since it not a dynamic listing , it will still list the default listing of first 10 records |
-
My Entities Listing API
Retrieves all entities that are under my group in a paginated manner. Set lіmit value as 5 with offset options as 0,5,10,15 and 20
|
Scenarios for Offset and lіmit |
Possible Outcomes |
|
When no Offset or lіmit value is given |
Then it will list 5 pages from record 1 onwards with default 5 records per page |
|
When Offset value is 0 and lіmit 5 is given |
It will list the first page with first 5 records |
|
When Offset value is 5 and lіmit 5 is given |
It will list the second page with next 5 records |
|
When Offset value is 20 and lіmit 5 is given |
It will list the last page with last 5 records |
|
When Offset value other than 0,5,10,15 and 20 and lіmit 5 is given |
Since it not a dynamic listing , it will still list the default listing of first 5 records |
|
When lіmit other than 5 is given |
It will still list the default listing of first 5 records |
-
Counterparty Entities Listing API
Retrieves the list of counterparties in a paginated manner
|
Scenarios for Offset and lіmit |
Possible Outcomes |
|
Lіmit:5 |
|
|
When no Offset value is given |
Then it will list 5 pages from record 1 onwards with default 5 records per page |
|
When Offset value is 0 and lіmit 5 is given |
It will list the first page with first 5 records |
|
When Offset value is 5 and lіmit 5 is given |
It will list the second page with next 5 records |
|
When Offset value is 25 and lіmit 5 is given |
It will list the last page with last 5 records |
|
When Offset value other than 0,5,10,15,20 and 25 and lіmit 5 is given |
Since it not a dynamic listing , it will still list the default listing of first 5 records |
|
Lіmit :10 |
|
|
When no Offset value is given |
Then it will list all 3 pages from record 1 onwards with default 10 records per page |
|
When Offset value is 0 and lіmit 10 is given |
It will list the first page with first 10 records |
|
When Offset value is 10 and lіmit 10 is given |
It will list the second page with next 10 records |
|
When Offset value is 20 and lіmіt 10 is given |
It will list the last page with last 10 records |
|
When Offset value other than 0,5,10,15,20 and 25 and lіmit 10 is given |
Since it not a dynamic listing , it will still list the default listing of first 5 records |
-
Data Retrieval API
It retrieves data points and documentId of supporting documents of Counterparty in JSON file
- For the FI entity use the entity’s BIC, LEI, tax ID or registration number:
- Set BIC as ARABDZALXXX
- Set LEI as CHSQDSVI1UI96Y2SW097
- Set tax ID as AB992292100011112044831
- Set registration number as Reg01234567879
- For the Corporate entities listed below use the entity’s BIC, LEI, tax ID or registration number:
| S No | Corp entities |
| 1 |
|
| 2 |
|
| 3 |
|
| 4 |
|
| 5 |
|
| 6 |
|
| 7 |
|
| 8 |
|
| 9 |
|
| 10 |
|
| 11 |
|
-
Profile Retrieval API (direct download)
For FI entity
-
- Set BIC as ARABDZALXXX
- Set LEI as CHSQDSVI1UI96Y2SW097
- Set tax ID as AB992292100011112044831
- Set registration number as Reg01234567879
For Corp Entity
-
- Set BIC as BKCHPAPAXXX
- Set LEI as 1A0BCD7LC1S92ABCDEG39
- Set tax ID as 123455
- Set registration number as 1224d-555-002023
|
Profile Retrieval scenarios (FI) |
Output |
|
When any of the above defined scenarios are executed |
It will extract the entity's KYC profile as a zip data folder with Json status as 200 |
|
When last-published-since date is given as 2021-09-01 |
It will return Json status as 204 |
|
Different BIC,LEI,Tax ID,Reg No,last-published-since a.set BIC as ARABYESAXXX b.set LEI as 7A0BCD7LC1S92ABCDEG39 c.set Tax ID as 123456 d.set Registration number as 1224d-555-002000 e.set last-published-date as 202220-12-31 |
It will throw json status as 400 |
-
Document Retrieval API (direct download)
For FI entity
- Set BIC as ARABDZALXXX and documentId as 6119cac6ae43be44c4877db5
- Set LEI as CHSQDSVI1UI96Y2SW097 and documentId as 6119c23640898738f8b84e9a
- Set Tax ID as AB992292100011112044831 and documentId as 6119c25840898738f8b84e9c
- Set Registration Number as Reg01234567879 and documentId as 6119c2a140898738f8b84e9e
For Corp
- Set BIC as BKCHPAPAXXX and documentId as 6119cac6ae43be44c4877ec6
- Set LEI as 1A0BCD7LC1S92ABCDEG39 and documentId as 6119cac6ae43be44c4877ec6
- Set Tax ID as 123455 and documentId as 5e7496d37428714a4e0fe311
- Set Registration Number as 1224d-555-002023 and documentId as 5e7496d37428714a4e0fe311