LinkCy

Corporate

List your corporates

Fetch all your corporates. More options will be added in the near future.

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Enum: "UPDATE_DATE" "CREATION_DATE"
registeredName
string
kybStatus
Array of strings
Items Enum: "NOT_STARTED" "COMPLETING" "PENDING_VERIFICATION" "NEED_ADDITIONAL_INFORMATION" "DECLINED" … 1 more
bankingStatus
Array of strings
Items Enum: "VALIDATED" "PENDING" "MISSING_DATA" "BLOCKED" "NOT_CREATED"
suspensionStatus
Array of strings
Items Enum: "SUSPENDED" "NOT_SUSPENDED"
linkcyStatus
Array of strings
Items Enum: "PENDING" "FORBIDDEN" "MISSING_DATA" "VALIDATED" "CLOSING" … 1 more
complianceStatus
Array of strings
Items Enum: "PENDING" "DECLINED" "PENDING_REVIEW" "VALIDATED"
overallStatus
string
Enum: "ACTIVE" "INACTIVE"
emailAddress
string
pageSize
integer <int32> <= 100

The size of the page to be returned.

page
integer <int32> >= 0

The page number.

sortDirection
string
Enum: "ASC" "DESC"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/partner/corporates
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Create a corporate
Create a new Corporate End-User who will perform banking operations.


SecurityNone or Linkcy-Auth 
Request 
Request Body schema: application/json
required
partnerName
string
The partnerName, mandatory if you create a corporate as anonymous. Ignored if requesting as a partner.


 
externalId
string  [ 0 .. 511 ] characters 
A unique identifier that you can use to link this corporate to a user in your system.


 
registeredName
required
string  [ 0 .. 255 ] characters 
The official corporate name. Must only contains Latin-1 characters.


 
tradeName
string  [ 0 .. 255 ] characters 
The name used for business if there is one. Must only contains Latin-1 characters.


 
incorporationCountry
required
string
The country where the corporate has been registered in ISO3 format.


 Enum: "ABW" "AFG" "AGO" "AIA" "ALA" … 240 more 
incorporationCode
required
string  [ 0 .. 255 ] characters 
The official incorporation code assigned in the country. Must only contains Latin-1 characters.


 
incorporationDate
string <date> 
The date the corporate was officially registered.


 
AustriaLegalType (object) or BelgiumLegalType (object) or BulgariaLegalType (object) or SwitzerlandLegalType (object) or CyprusLegalType (object) or CzechiaLegalType (object) or GermanyLegalType (object) or DenmarkLegalType (object) or EstoniaLegalType (object) or SpainLegalType (object) or FinlandLegalType (object) or FranceLegalType (object) or MonacoLegalType (object) or UnitedKingdomLegalType (object) or GreeceLegalType (object) or CroatiaLegalType (object) or HungaryLegalType (object) or IrelandLegalType (object) or IcelandLegalType (object) or ItalyLegalType (object) or LiechtensteinLegalType (object) or LithuaniaLegalType (object) or LuxembourgLegalType (object) or LatviaLegalType (object) or MaltaLegalType (object) or NetherlandsLegalType (object) or NorwayLegalType (object) or PolandLegalType (object) or PortugalLegalType (object) or RomaniaLegalType (object) or SwedenLegalType (object) or SloveniaLegalType (object) or SlovakiaLegalType (object) (CorporateApiLegalType) 
 
website
string  [ 0 .. 511 ] characters 
 
industry
required
string
 Enum: "CHILD_ADOPTION" "ADULT_ENTERTAINMENT" "DATING_SERVICES" "ESCORT_SERVICES" "ARMS_TRADE_AND_DEFENSE" … 131 more 
vatNumber
string
The corporate VAT number.


 
required
object (EuropeanAddressRequest) 
 
object (EuropeanAddressRequest) 
 
required
object (ExpectedMonthlyExpenses) 
 
employeesRange
string
Range of the number of employees working for the corporate.


 Enum: "BTW_1_AND_10" "BTW_11_AND_50" "MORE_THAN_50"  
accountPurposes
Array of strings  unique 
Items Enum: "PAY_BILLS" "MONEY_TO_FROM_FAMILY" "DIVIDENDS" "SAVINGS" "PERSONAL_BUSINESS_PURPOSES" … 8 more 
lastTermsAccepted
string
The version of the terms and conditions signed by the corporate account owner.


 
required
object (AccountOwnerInfo) 
Information of the person who will manage this corporate end-user account.


 
metadata
object (JsonNode) 
A custom field to save data.


This field's size is limited to 3000 characters.


 
Responses 
201
Created


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/api/partner/corporates
Request samples 
application/json
{
  • "partnerName": "string",
  • "externalId": "string",
  • "registeredName": "string",
  • "tradeName": "string",
  • "incorporationCountry": "FRA",
  • "incorporationCode": "12345678900013",
  • "incorporationDate": "2019-08-24",
  • "legalType": {
    },
  • "website": "string",
  • "industry": "CHILD_ADOPTION",
  • "vatNumber": "string",
  • "registeredAddress": {
    },
  • "businessAddress": {
    },
  • "expectedMonthlyExpenses": {
    },
  • "employeesRange": "BTW_1_AND_10",
  • "accountPurposes": [
    ],
  • "lastTermsAccepted": "1.0",
  • "accountOwnerInfo": {
    },
  • "metadata": { }
}
Response samples 
application/json
{
  • "corporateId": "50eb73c4-9d2f-4e30-9f0c-2d57c30a46ee",
  • "accountOwnerId": "41bfc29a-63f5-4057-9938-10cfd5e1771b"
}
Get corporate's information
Get all information about a corporate using only its corporate ID.


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


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


get/api/partner/corporates/{corporateId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "externalId": "string",
  • "registeredName": "string",
  • "tradeName": "string",
  • "incorporationCountry": "ABW",
  • "incorporationCode": "string",
  • "incorporationDate": "2019-08-24",
  • "legalType": "AL_SHOQERI_AKSIONERE_SHA",
  • "website": "string",
  • "industry": "CHILD_ADOPTION",
  • "vatNumber": "string",
  • "registeredAddress": {
    },
  • "businessAddress": {
    },
  • "employeesRange": "BTW_1_AND_10",
  • "expectedMonthlyExpenses": {
    },
  • "accountPurposes": [
    ],
  • "complianceInfo": {
    },
  • "termsAccepted": true,
  • "notes": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "status": {
    },
  • "strongAuthentication": {
    },
  • "partnerMetadata": { },
  • "userMetadata": { }
}
Update a corporate
You can patch a corporate to update some information. Once the KYB status is VALIDATED or DECLINED, you will not be able to patch new information except to change the account owner or the external identifier.


SecurityLinkcy-Auth 
Request 
path Parameters
corporateId
required
string <uuid> 
 
Request Body schema: application/json
required
externalId
string  [ 0 .. 511 ] characters 
A unique identifier that you can use to link this corporate to a user in your system.


 
registeredName
string  [ 0 .. 255 ] characters 
The official corporate name. Must only contains Latin-1 characters.


 
tradeName
string  [ 0 .. 255 ] characters 
The name used for business if there is one. Must only contains Latin-1 characters.


 
incorporationCountry
string
The country where the corporate has been registered in ISO3 format.


 Enum: "ABW" "AFG" "AGO" "AIA" "ALA" … 240 more 
incorporationCode
string  [ 0 .. 255 ] characters 
The official incorporation code assigned in the country. Must only contains Latin-1 characters.


 
incorporationDate
string <date> 
The date the corporate was officially registered.


 
AustriaLegalType_Partner (object) or BelgiumLegalType_Partner (object) or BulgariaLegalType_Partner (object) or SwitzerlandLegalType_Partner (object) or CyprusLegalType_Partner (object) or CzechiaLegalType_Partner (object) or GermanyLegalType_Partner (object) or DenmarkLegalType_Partner (object) or EstoniaLegalType_Partner (object) or SpainLegalType_Partner (object) or FinlandLegalType_Partner (object) or FranceLegalType_Partner (object) or MonacoLegalType_Partner (object) or UnitedKingdomLegalType_Partner (object) or GreeceLegalType_Partner (object) or CroatiaLegalType_Partner (object) or HungaryLegalType_Partner (object) or IrelandLegalType_Partner (object) or IcelandLegalType_Partner (object) or ItalyLegalType_Partner (object) or LiechtensteinLegalType_Partner (object) or LithuaniaLegalType_Partner (object) or LuxembourgLegalType_Partner (object) or LatviaLegalType_Partner (object) or MaltaLegalType_Partner (object) or NetherlandsLegalType_Partner (object) or NorwayLegalType_Partner (object) or PolandLegalType_Partner (object) or PortugalLegalType_Partner (object) or RomaniaLegalType_Partner (object) or SwedenLegalType_Partner (object) or SloveniaLegalType_Partner (object) or SlovakiaLegalType_Partner (object) (CorporateApiLegalType_Partner) 
 
website
string  [ 0 .. 511 ] characters 
 
industry
string
 Enum: "CHILD_ADOPTION" "ADULT_ENTERTAINMENT" "DATING_SERVICES" "ESCORT_SERVICES" "ARMS_TRADE_AND_DEFENSE" … 131 more 
vatNumber
string
The corporate VAT number.


 
object (EuropeanAddressRequest) 
Address that will be used on the bank statements of your users.


 
object (EuropeanAddressRequest) 
Address that will be used on the bank statements of your users.


 
object (ExpectedMonthlyExpenses) 
 
employeesRange
string
The number of employees working for the corporate.


 Enum: "BTW_1_AND_10" "BTW_11_AND_50" "MORE_THAN_50"  
accountPurposes
Array of strings  unique 
Items Enum: "PAY_BILLS" "MONEY_TO_FROM_FAMILY" "DIVIDENDS" "SAVINGS" "PERSONAL_BUSINESS_PURPOSES" … 8 more 
lastTermsAccepted
string
The version of the terms and conditions signed by the corporate account owner.


 
object (Metadata) 
 Deprecated 
Use userMetadata or partnerMetadata instead.


 
object (User metadata) 
A custom field to save data.


This field's size is limited to 3000 characters.


 
object (Partner metadata) 
A custom field to save data that cannot be modified by the end-user.


This field's size is limited to 3000 characters.


Note: if you are authenticated as end-user, trying to update this field will result in a Forbidden Error.


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


patch/api/partner/corporates/{corporateId}
Request samples 
application/json
{
  • "externalId": "string",
  • "registeredName": "string",
  • "tradeName": "string",
  • "incorporationCountry": "FRA",
  • "incorporationCode": "12345678900013",
  • "incorporationDate": "2019-08-24",
  • "legalType": {
    },
  • "website": "string",
  • "industry": "CHILD_ADOPTION",
  • "vatNumber": "string",
  • "registeredAddress": {
    },
  • "businessAddress": {
    },
  • "expectedMonthlyExpenses": {
    },
  • "employeesRange": "BTW_1_AND_10",
  • "accountPurposes": [
    ],
  • "lastTermsAccepted": "1.0",
  • "metadata": {
    },
  • "userMetadata": {
    },
  • "partnerMetadata": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updateDate": "2019-08-24T14:15:22Z"
}
➔ Next to KYC