Sorry, you need to enable JavaScript to visit this website.

KYC Registry API Sandbox Guide

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 (limited) 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 (limited): https://sandbox.swift.com/kyc/v1

 

Sandbox Scenarios 

  1. Access Request API

Set My entity BIC to AAAABBCCXXX

Set Counterparty BIC to BKCHCATTXXX

 

  1. 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’ & limit 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’ &limit as 10  with range of offset values as 0,10 and 20

 

Scenarios for Offset and limit

Possible Outcomes

When no Offset or limit 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 limit 10 is given

It will list the first page with first 10 records

When Offset value is 10 and limit 10 is given

It will list the second page with next 10 records

When Offset value is 20 and limit 10 is given

It will list the last page with last 5 records

When Offset value is 0 and limit 5 is given

It will list the first page with first 5 records

When Offset value is 5 and limit 5 is given

It will list from record 5th onwards

When Offset value is 10 and limit 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 

 

 

  1. My Entities Listing API

Retrieves all entities that are under my group in a paginated manner. Set limit value as 5 with offset options as 0,5,10,15 and 20

 

Scenarios for Offset and limit

Possible Outcomes

When no Offset or limit 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 limit 5 is given

It will list the first page with first 5 records

When Offset value is 5 and limit 5 is given

It will list the second page with next 5 records

When Offset value is 20 and limit 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 limit 5 is given

Since it not a dynamic listing , it will still list the default listing of first 5 records 

When limit other than 5 is given

It will still list the default listing of first 5 records 

 

  1. Counterparty Entities Listing API

Retrieves the list of counterparties in a paginated manner

 

Scenarios for Offset and limit

Possible Outcomes

Limit: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 limit 5 is given

It will list the first page with first 5 records

When Offset value is 5 and limit 5 is given

It will list the second page with next 5 records

When Offset value is 25 and limit 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 limit 5 is given

Since it not a dynamic listing , it will still list the default listing of first 5 records 

Limit :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 limit 10 is given

It will list the first page with first 10 records

When Offset value is 10 and limit 10 is given

It will list the second page with next 10 records

When Offset value is 20 and limit 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 limit 10 is given

Since it not a dynamic listing , it will still list the default listing of first 5 records 

 

  1. 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
  • Set BIC as BKCHPAPAXXX
  • Set LEI as 1A0BCD7LC1S92ABCDEG39
  • Set tax ID as 123455
  • Set registration number as 1224d-555-002023
2
  • Set BIC as CANINC11XXX
  • Set LEI as 529900JH1GSC035SSP77
  • Set tax ID as 11-1556860
  • Set registration number as 77510
3
  • Set BIC as AMZINC10XXX
  • Set LEI as ZXTILKJKG63JELOEG630
  • Set tax ID as 91-1646860
  • Set registration number as 2620453
4
  • Set BIC as BESBUY22XXX
  • Set LEI as HL5XPTVRV0O8TUN5LL90
  • Set tax ID as 41-0907483
  • Set registration number as 1K-1056
5
  • Set BIC as SPOSAT33XXX
  • Set LEI as 549300B4X0JHWV0DTD60
  • Set tax ID as 11-7789121
  • Set registration number as B0123052
6
  • Set BIC as AMEAIR77XXX
  • Set LEI as 689300B4X0JHWV0DYR45  
  • Set tax ID as 75-1825172
  • Set registration number as 931981
7
  • Set BIC as ALPINC26XXX
  • Set LEI as 5493006MHB84DD0ZWV18
  • Set tax ID as 61-1767919
  • Set registration number as C3831672
8
  • Set BIC as SAMSUN65XXX
  • Set LEI as 9884007ER46L6N7EI764
  • Set tax ID as 124-81-00998
  • Set registration number as 000905
9
  • Set BIC as WALDIS97XXX
  • Set LEI as 549300GZKULIZ0WOW665
  • Set tax ID as 83-0940635
  • Set registration number as 6931540
10
  • Set BIC as APPINC56XXX
  • Set LEI as 756300B4X0JHWV0DYR45
  • Set tax ID as 94-2404110
  • Set registration number as C0806592
11
  • Set BIC as OCLCOR66XXX   
  • Set LEI as 298300B4X0JHWGODYR45
  • Set tax ID as 54-2185193
  • Set registration number as Z7890167
  1. 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

 

  1. 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

 

Getting Started

Limited teaser(v1)