Profile Management APIs

23. 12. 2024

This set of APIs allows to manage customer identification (KYC) process.
The KYC process can be performed by the system user with appropriate permissions.
The SDK.finance platform provides essential KYC functionality such as uploading and verifying user documents and data, and changing their status accordingly.

Client’s identification status is shown in the profile information:

"type": "base",
    "status": "approved",
    "business": {
      "companyName": "TestCompanyName2",
      "type": "high_risk",
      "vat": "IE1234567T",
      "administrator": {
        "firstName": "Adler",
        "lastName": "Aust",
        "email": "test_new_33@mailinator.com",
        "phone": "3806700000000"
      }

Profile – documents management

A set of APIs to upload verification documents and send them for KYC.

Profile – Master PIN

Master Pin is used for Transaction confirmation if it is enabled in the user profile settings.
This API set allows users to manage Master PIN.

Profile – transactions confirmation settings

This API set allows managing of transaction confirmation settings in the user profile.
Users can enable confirmation for the transactions and specify the way of this confirmation: PIN or OTP.
If it is enabled, the user will have to confirm the transaction to be processed.

Profile management by owner

This API set allows users with business roles to view and manage their profiles.
Profile management by service role

This API set allows users with service roles to view and manage user profiles.
The user profile contains the following sets of information which can be viewed and managed:

Set of Information	Parameters	Description
Person	`"person": {` `"namePlain": {` `"first": "Alex",` `"last": "Dot",` `"middle": "string"` `},` `"nameIntl": {` `"first": "Alex",` `"last": "Dot",` `"middle": "string"` `},` `"phoneNumber": "38005550066",` `"email": "test_new_33@mailinator.com",` `"dateOfBirth": "2023-03-08T15:32:19.296Z",` `"systemLanguage": "en",` `"nationality": "EE",` `"taxResidenceCountry": "UA",` `"taxNumb2er": "1231231"` `},`	Contains personal information about the User
Contact	`"contact": {` `"phoneNumber": "380631111111",` `"phoneVerified": true,` `"email": "individual@sdkfinance.tech",` `"emailVerified": true,` `"countryCode": "UA"` `},`
type	`"type": "base"`	Shows the type of organisation which refers to the contract type.
status	`"status": "approved",`	Shows the current profile KYC status.
business	`"business":` `{` `"companyName": "TestCompanyName2",` `"type": "high_risk",` `"vat": "IE1234567T",` `"administrator": {` `"firstName": "Adler",` `"lastName": "Aust",` `"email": "test_new_33@mailinator.com",` `"phone": "3806700000000"` `}` `},`	Contains information about Client’s business (can be hidden for Individuals and reflected only for Merchants or Corporates)
address	`"address": [` `{` `"country": "UA",` `"addressType": "PERSONAL",` `"zipCode": "46000",` `"city": "Ternopil",` `"region": "Bombas",` `"street": "Zelena",` `"houseNumber": "12"` `}` `]`
additional	`{` `"additional": {` `"type": "common",` `"birthday": "2024-12-06T11:58:11.242Z",` `"sex": "MALE",` `"referenceToProfilePhoto": "https://local.sdk.finance:443/api/v1/media-files/resources/604f7bde-ffe5-4e48-9868-824bc6a2263e.png",` `"timezone": "+05:30"` `}` `}`
security-settings	`"security": {` `"twoFactorsAuthEnabled": false,` `"notificationSettings": [` `{` `"phone": false,` `"email": false,` `"notificationEventType": "TRANSACTION"` `},` `{` `"phone": false,` `"email": false,` `"notificationEventType": "AUTHENTICATION"` `},` `{` `"phone": false,` `"email": false,` `"notificationEventType": "KYC_IDENTIFICATION_STATUS_CHANGE"` `},` `{` `"phone": false,` `"email": false,` `"notificationEventType": "PROFILE_UPDATE_REQUIRED"` `},` `{` `"phone": false,` `"email": false,` `"notificationEventType": "RESET_IDENTIFICATION_REQUEST_APPROVED"` `},` `{` `"phone": false,` `"email": false,` `"notificationEventType": "ACCOUNT_BLOCKED"` `},` `{` `"phone": false,` `"email": false,` `"notificationEventType": "PASSWORD_RECOVERED"` `}` `]` `},`	Shows the current configuration of security settings such as: Two Factor Authorization, and notifications about transactions, login, KYC status change and other actions. Users can switch notifications on and off and choose how to receive such notifications (phone or email.)
integration	`"integration": {` `"openBankingCustomerId": "1260431181640370585",` `"leadStatus": "verified"` `}`
Role	`"role": [` `{` `"code": "string",` `"permissions": [` `"string"` `],` `"bundleKey": "string"` `}` `]`
Memberships	`"memberShips": [` `{` `"organizationId": "61b065de-58ef-4959-ab5e-4a2d75ab6564",` `"roleName": "individual"` `}`	Shows in which organisation the particular user is the member.