KYC Registry document provider

Version 5

🎯 Functional documentation

This provider can be used to import documents from banks (companies). This provider checks the SWIFT/BIC number of the bank in order to perform the import.

⚙️ Configuration

Implementation class

KYCRegistryCompanyV5DocumentProvider

Migration notes

No Configuration changes were made in version 5. The configuration from version 4 can be reused.

Required authentication settings

• resource Uri: https://api.swift.com/kyc/

Settings

Settings Configuration

Examples

Version 4

🎯 Functional documentation

This provider can be used to import documents from banks (companies). This provider checks the SWIFT/BIC number of the bank in order to perform the import.

⚙️ Configuration

Implementation class

KYCRegistryCompanyV4DocumentProvider

Required authentication settings

• resource Uri: https://api.swift.com/kyc/

Settings

• accessRequestEntity (required): entity used to request access to KYC registry when the access it not yet ok.
• password (required): password to fetch a valid OAuth2 access token.
• swiftBicMetadataKey (required): key of the party metadata field that contains the BIC/SWIFT code.
• username(required): username to fetch a valid OAuth2 access token.

{
    "PROVIDER_DISPLAY_NAME": "KYC registry document provider",
    "accessRequestEntity": "myEntity",
    "password": "$vault{KYC_REGISTRY_<client>_password}",
    "swiftBicMetadataKey": "METADATA_COMPANY_SWIFTBIC",
    "username": "$vault{KYC_REGISTRY_<client>_username}"
}

Version 3

🎯 Functional documentation

This provider can be used to upload company documents from KYC registry.

Input data points

When creating a party, a search is supported based on the SWIFT/BIC code.

⚙️ Configuration

Required authorization settings

• clientId
• clientSecret
• tokenUri: https://api.swift.com/oauth2/v1/token
• resourceUri: https://api.swift.com/kyc/

Implementation class

KYCRegistryCompanyV4DocumentProvider

Settings:

• API_KEY
• swiftBicMetadataKey (required): defines the metadata key that holds the SWIFT/BIC code.
• username (required): required for authorization using OAuth
• password (required): required for authorization using OAuth
• sharesMetadataKey: only required when fetching related parties (module `PARTY_RELATED_PARTIES)
• accessRequestEntity: this property is used when the data retrieval returns a 403 Forbidden, because then an additional call is made to request access. Example

{
    "PROVIDER_DISPLAY_NAME": "KYC registry document provider",
    "accessRequestEntity": "myEntity",
    "password": "$vault{KYC_REGISTRY_<client>_password}",
    "username": "$vault{KYC_REGISTRY_<client>_username}",
    "sharesMetadataKey": "DIRECT_SHARE_PERCENTAGE",
    "swiftBicMetadataKey": "company_bic"
}