KYB

Get corporate-related entities list

Get access to the information of all related entities of a corporate.

SecurityLinkcy-Auth
Request
path Parameters
corporateId
required
string <uuid>
query Parameters
required
object (CorporateRelatedEntitiesListRequestDto)
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

get/api/partner/corporates/{corporateId}/related
Request samples
Response samples
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}

Declare a corporate-related entity (person or corporate)

Add a person or corporate-related to the current corporate who may be the account owner, a director or a UBO (shareholder with 25%+ shares (10% if the corporate required extended UBOs)).

Adding all the directors and UBOs of the corporate is a mandatory step to complete the KYB and access all banking features.

After adding a corporate-related person, you must provide them with a KYC link.

SecurityLinkcy-Auth
Request
path Parameters
corporateId
required
string <uuid>
Request Body schema: application/json
isDirector
required
boolean

Indicates if this entity is a director of the corporate.

directorAppointmentDate
string <date-time>

If director, the date on which he was appointed.

object (ShareInfoRequestDto)

Must be filled in if UBO(shareholder with 25%+ shares or 10%+ shares if the corporate must provide extended UBOs).

required
CorporateRelatedPhysicalPersonInfoDto (object) or CorporateRelatedCorporateInfoDto (object) (CorporateRelatedInfoDto)

Information about this corporate-related entity.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409
500

Internal Server Error

post/api/partner/corporates/{corporateId}/related
Request samples
application/json
{
  • "isDirector": true,
  • "directorAppointmentDate": "2019-08-24T14:15:22Z",
  • "sharesInfo": {
    },
  • "info": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Ask a KYB verification

This endpoint allows you to ask a KYB verification for a Corporate End-User.

In order to use this endpoint, all its UBOs and directors must have been declared and have completed a validated KYC application.

After using this endpoint, a Linkcy compliance officer will verify the information provided and update the KYB status to one of the following values:

  • VALIDATED -> this corporate is now authorized to access Linkcy's banking features.

  • NEED_ADDITIONAL_INFORMATION -> Additional information is needed to validate this corporate. The description of the requested information will be displayed in the kybStatusReason field.

  • DECLINED -> this corporate violates compliance rules and is not authorized to use Linkcy's banking features.

SecurityLinkcy-Auth
Request
path Parameters
corporateId
required
string <uuid>
Responses
204

The KYB verification request was sent successfully

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

post/api/partner/corporates/{corporateId}/kyb/verification/ask
Request samples
Response samples
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Get corporate-related entity's information

Get all information about a related entity of a corporate using only it's id.

SecurityLinkcy-Auth
Request
path Parameters
corporateId
required
string <uuid>
corporateRelatedId
required
string <uuid>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

get/api/partner/corporates/{corporateId}/related/{corporateRelatedId}
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "externalId": "string",
  • "corporate": {
    },
  • "shareInfo": {
    },
  • "address": {
    },
  • "phone": {
    },
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "email": {
    },
  • "gender": "MALE",
  • "birthIsoCountryCode": "string",
  • "birthDate": "2019-08-24",
  • "kycInfo": {
    },
  • "notes": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "position": {
    }
}

Update a corporate-related entity (person or corporate)

You can patch a corporate related to update some information whether it's a corporate or a person. Depending on the information patched, you will have to perform another action:

  • As a person:
  • First name -> no actions to perform

  • Last name -> no actions to perform

  • Phone -> you will need to use Endpoint POST Send consumer verification code & validate consumer phone

  • Address : we will use our tools to check if the address is valid or not, we recommend you to ask your consumer to confirm the address once the modification is done. Address is very important to send cards. Once the card is activated, the address status will go from valid to verified.

  • Email address -> The "emailAddressVerified" status will switch to "false" you will need to use Endpoint POST Send a verification email to the consumer to verify the email address.

  • As a corporate:
  • Registered name -> no actions to perform

  • Incorporation code -> no actions to perform

  • Incorporation country -> no actions to perform

SecurityLinkcy-Auth
Request
path Parameters
corporateId
required
string <uuid>
corporateRelatedId
required
string <uuid>
Request Body schema: application/json
Any of:

The information to update a corporate related.

externalId
string [ 0 .. 511 ] characters

A unique identifier that you can use to link this corporate related to a user in your system.

isDirector
boolean

Indicates if this entity is a director of the corporate.

directorAppointmentDate
string <date-time>

If director, the date on which he was appointed.

object

Must be filled in if UBO(shareholder with 25%+ shares or 10%+ shares if the corporate must provide extended UBOs).

firstName
string [ 0 .. 255 ] characters
middleName
string [ 0 .. 255 ] characters
lastName
string [ 0 .. 255 ] characters
object (AddressRequestDto)
nationality
string
emailAddress
string
object (PhoneRequestDto)
isSpecialUbo
boolean

Indicates whether this person was designated UBO because no shareholder holds the percentage of shares required to become one.

director
boolean

Indicates if this entity is a director of the corporate.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409
500

Internal Server Error

patch/api/partner/corporates/{corporateId}/related/{corporateRelatedId}
Request samples
application/json
{
  • "externalId": "string",
  • "isDirector": true,
  • "directorAppointmentDate": "2019-08-24T14:15:22Z",
  • "sharesInfo": {
    },
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "address": {
    },
  • "nationality": "string",
  • "emailAddress": "string",
  • "phone": {
    },
  • "isSpecialUbo": true,
  • "director": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get diligence review of a corporate

SecurityLinkcy-Auth
Request
path Parameters
corporateId
required
string <uuid>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

get/api/partner/documents/diligence-review/{corporateId}
Request samples
Response samples
application/json
"string"