Corporate

List your corporates

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

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Value: "UPDATE_DATE"
pageSize
integer <int32> [ 0 .. 100 ]
Default: 20

The size of the page to be returned.

page
integer <int32> >= 0
Default: 0

The page number.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

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.

SecurityLinkcy-Auth or
Request
Request Body schema: application/json
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.

corporateName
required
string [ 0 .. 255 ] characters

The official corporate name.

tradeName
string [ 0 .. 255 ] characters

The name used for business if there is one.

incorporationCountry
required
string

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

incorporationCode
required
string [ 0 .. 255 ] characters

The official incorporation code assigned in the country.

incorporationDate
string <date-time>

The date the corporate was officially registered.

AustriaLegalType (object) or BosniaHerzegovinaLegalType (object) or BelgiumLegalType (object) or BulgariaLegalType (object) or CzechiaLegalType (object) or GermanyLegalType (object) or DenmarkLegalType (object) or EstoniaLegalType (object) or SpainLegalType (object) or FinlandLegalType (object) or FranceLegalType (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 MontenegroLegalType (object) or NorthMacedoniaLegalType (object) or NetherlandsLegalType (object) or NorwayLegalType (object) or PolandLegalType (object) or PortugalLegalType (object) or RomaniaLegalType (object) or SerbiaLegalType (object) or RussianFederationLegalType (object) or SwedenLegalType (object) or SloveniaLegalType (object) or SlovakiaLegalType (object) or UkraineLegalType (object) (CorporateApiLegalType)
website
string [ 0 .. 511 ] characters
industry
required
string
Enum: "CHILD_ADOPTION" "ADULT_ENTERTAINMENT" "DATING_SERVICES" "ESCORT_SERVICES" "ARMS_TRADE_AND_DEFENSE" "HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES" "USED_CAR_RESALE_AND_DISTRIBUTION" "AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES" "FOOD_RESTAURANT_CATERING" "CHARITY_NON_RECOGNIZED" "CHARITY_RECOGNIZED" "TRANSPORT_TAXI_SERVICES_CHAUFFEUR" "ARCHITECTS_LICENSED" "INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN" "PLUMBING_ELECTRICIANS_KEY_CONTRACTORS" "CONSTRUCTION" "INFRASTRUCTURE" "CONSULTANCY_LICENSED_TAX_OR_OTHER" "CONSULTANCY_NON_LICENSED" "MARKETING_AGENCIES_NON_ONLINE" "MARKETING_SERVICES_AFFILIATE_MANAGERS" "MULTI_LEVEL_MARKETING" "SECURITY_SERVICES_ARMED" "SECURITY_SERVICES_NON_ARMED" "RESCUE" "INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY" "CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT" "CRYPTO_EXCHANGE_LICENSED" "CRYPTO_EXCHANGE_NON_LICENSED" "CRYPTO_MINING" "ICO" "EXPORT_IMPORT_OF_GENERAL_GOODS" "FOOD_OR_APPAREL" "EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS" "GREEN_TECHNOLOGIES_AND_PRODUCTS_NON_DUAL_USE" "TRADER_OF_DUAL_USE_GOOD_LICENSED" "TRADER_OF_DUAL_USE_GOOD_NON_LICENSED" "TRADERS_OF_COMMODITIES" "DRUG_PARAPHERNALIA" "PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS" "SCHOOLS_AND_ACADEMIES_LICENSED" "BAR" "CAFETERIA" "CLUB_DISCO" "MOVIES_CINEMA_TELEVISION" "MUSIC_PRODUCTION" "GAS_OIL_EXTRACTION_EQUIPMENT" "MINERAL_EXTRACTION" "OIL_GAS_EXTRACTION" "QUARRYING" "CARDS_ISSUERS_ACQUIRERS_LICENSED" "FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT" "FOREIGN_EXCHANGE_LICENSED" "FOREIGN_EXCHANGE_NOT_LICENSED" "INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT" "INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT" "INSURERS_NOT_LICENSED" "INVESTMENTS_LICENSED" "INVESTMENTS_NOT_LICENSED" "MONEY_REMITTANCE_LICENSED" "MONEY_REMITTANCE_NOT_LICENSED" "PAYMENT_GATEWAY" "PRIVATE_BANKING_LICENSED" "PRIVATE_BANKING_NOT_LICENSED" "PAYMENT_SERVICE_PROVIDER_LICENSED" "PAYMENT_SERVICE_PROVIDER_NOT_LICENSED" "GOVERNMENT" "HOTEL_B_AND_B_GUESTHOUSE_HOSTELS" "IT_SERVICES" "ROYALTIES_AND_OR_LICENSES" "IIPS_AND_VISA_APPLICATION_CONSULTANCY" "LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT" "LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT" "NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT" "NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT" "TRUST_FIDUCIARIES_NOT_LICENSED" "TRUST_FIDUCIARIES_LICENSED" "ANTIQUE_DEALER_AUCTIONEER" "ART_DEALERS" "DESIGNER_APPAREL_AND_CLOTHING" "FASHION_DESIGNERS_CONSULTANTS" "JEWELERS" "WATCHES_AND_COLLECTABLES" "CAR_MANUFACTURING" "ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS" "MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS" "METALLURGY" "PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM" "PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM" "PLASTIC_AND_OTHER_OIL_COMPOUNDS" "TEXTILES" "SALES_MANUFACTURING_OF_VESSELS" "YACHTING_CHARTERING" "BROKER_LICENSED" "BROKER_NOT_LICENSED" "CHIROPRACTORS_LICENSED" "DENTISTS_LICENSED" "GENERAL_MEDICAL_PRACTITIONERS" "HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS" "MEDICAL_LABORATORIES_LICENSED" "VETERINARY_CLINICS" "PRECIOUS_METALS_NON_RAW" "RADIOACTIVE_MATERIALS" "RAW_PRECIOUS_METALS" "NGO_NOT_RECOGNIZED" "NGO_RECOGNIZED" "PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS" "FOOTBALL_CLUBS" "GAMING_GAMBLING_LICENSED_B2B_AND_B2C" "GAMING_GAMBLING_NOT_LICENSED" "GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES" "GAMING_ONLINE_VIDEO_GAMES" "BIOTECH" "MEDICAL_CANNABIS_LICENSED" "NUTRACEUTICALS" "PHARMACEUTICALS_LICENSED" "PHARMACEUTICALS_NOT_LICENSED" "PUBLIC_LISTED_COMPANY" "PROPERTY_MANAGEMENT" "REAL_ESTATE" "WASTE_MANAGEMENT_TECHNOLOGIES" "FUEL_REFINERY_AND_DISTRIBUTION" "ECOMMERCE_TRADER_FOR_GENERAL_GOODS" "FURNITURE_STORES" "GENERAL_APPAREL" "CLEANING_SERVICES" "TRANSLATORS" "CLIENT" "ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES" "TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT" "TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT" "TOBACCO_AND_LIQUORS_LICENSED" "TRAVEL_AGENTS" "BEAUTY_CLINICS_AND_HAIR_SALON" "SPAS" "GYMS_AND_WELLNESS_CENTERS"
required
object (AddressRequestDto)
object (AddressRequestDto)
required
object (ExpectedMonthlyExpensesDto)
employeesRange
string

Range of the number of employees working for the corporate.

Enum: "BTW_1_AND_10" "BTW_11_AND_50" "MORE_THAN_50"
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
500

Internal Server Error

post/api/partner/corporates
Request samples
application/json
{
  • "partnerName": "string",
  • "externalId": "string",
  • "corporateName": "string",
  • "tradeName": "string",
  • "incorporationCountry": "FRA",
  • "incorporationCode": "12345678900013",
  • "incorporationDate": "2019-08-24T14:15:22Z",
  • "legalType": {
    },
  • "website": "string",
  • "industry": "CHILD_ADOPTION",
  • "registeredAddress": {
    },
  • "businessAddress": {
    },
  • "expectedMonthlyExpenses": {
    },
  • "employeesRange": "BTW_1_AND_10",
  • "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

409

Conflict

500

Internal Server Error

get/api/partner/corporates/{corporateId}
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "externalId": "string",
  • "corporateName": "string",
  • "tradeName": "string",
  • "incorporationCountry": "string",
  • "incorporationCode": "string",
  • "incorporationDate": "2019-08-24T14:15:22Z",
  • "legalType": "AL_SHOQERI_AKSIONERE_SHA",
  • "website": "string",
  • "industry": "CHILD_ADOPTION",
  • "registeredAddress": {
    },
  • "businessAddress": {
    },
  • "employeesRange": "BTW_1_AND_10",
  • "expectedMonthlyExpenses": {
    },
  • "kybInfo": {
    },
  • "complianceInfo": {
    },
  • "termsAccepted": true,
  • "notes": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "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
externalId
string [ 0 .. 511 ] characters

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

corporateName
string [ 0 .. 255 ] characters

The official corporate name.

tradeName
string [ 0 .. 255 ] characters

The name used for business if there is one.

incorporationCountry
string

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

incorporationCode
string [ 0 .. 255 ] characters

The official incorporation code assigned in the country.

incorporationDate
string <date-time>

The date the corporate was officially registered.

AustriaLegalType (object) or BosniaHerzegovinaLegalType (object) or BelgiumLegalType (object) or BulgariaLegalType (object) or CzechiaLegalType (object) or GermanyLegalType (object) or DenmarkLegalType (object) or EstoniaLegalType (object) or SpainLegalType (object) or FinlandLegalType (object) or FranceLegalType (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 MontenegroLegalType (object) or NorthMacedoniaLegalType (object) or NetherlandsLegalType (object) or NorwayLegalType (object) or PolandLegalType (object) or PortugalLegalType (object) or RomaniaLegalType (object) or SerbiaLegalType (object) or RussianFederationLegalType (object) or SwedenLegalType (object) or SloveniaLegalType (object) or SlovakiaLegalType (object) or UkraineLegalType (object) (CorporateApiLegalType)
website
string [ 0 .. 511 ] characters
industry
string
Enum: "CHILD_ADOPTION" "ADULT_ENTERTAINMENT" "DATING_SERVICES" "ESCORT_SERVICES" "ARMS_TRADE_AND_DEFENSE" "HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES" "USED_CAR_RESALE_AND_DISTRIBUTION" "AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES" "FOOD_RESTAURANT_CATERING" "CHARITY_NON_RECOGNIZED" "CHARITY_RECOGNIZED" "TRANSPORT_TAXI_SERVICES_CHAUFFEUR" "ARCHITECTS_LICENSED" "INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN" "PLUMBING_ELECTRICIANS_KEY_CONTRACTORS" "CONSTRUCTION" "INFRASTRUCTURE" "CONSULTANCY_LICENSED_TAX_OR_OTHER" "CONSULTANCY_NON_LICENSED" "MARKETING_AGENCIES_NON_ONLINE" "MARKETING_SERVICES_AFFILIATE_MANAGERS" "MULTI_LEVEL_MARKETING" "SECURITY_SERVICES_ARMED" "SECURITY_SERVICES_NON_ARMED" "RESCUE" "INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY" "CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT" "CRYPTO_EXCHANGE_LICENSED" "CRYPTO_EXCHANGE_NON_LICENSED" "CRYPTO_MINING" "ICO" "EXPORT_IMPORT_OF_GENERAL_GOODS" "FOOD_OR_APPAREL" "EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS" "GREEN_TECHNOLOGIES_AND_PRODUCTS_NON_DUAL_USE" "TRADER_OF_DUAL_USE_GOOD_LICENSED" "TRADER_OF_DUAL_USE_GOOD_NON_LICENSED" "TRADERS_OF_COMMODITIES" "DRUG_PARAPHERNALIA" "PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS" "SCHOOLS_AND_ACADEMIES_LICENSED" "BAR" "CAFETERIA" "CLUB_DISCO" "MOVIES_CINEMA_TELEVISION" "MUSIC_PRODUCTION" "GAS_OIL_EXTRACTION_EQUIPMENT" "MINERAL_EXTRACTION" "OIL_GAS_EXTRACTION" "QUARRYING" "CARDS_ISSUERS_ACQUIRERS_LICENSED" "FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT" "FOREIGN_EXCHANGE_LICENSED" "FOREIGN_EXCHANGE_NOT_LICENSED" "INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT" "INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT" "INSURERS_NOT_LICENSED" "INVESTMENTS_LICENSED" "INVESTMENTS_NOT_LICENSED" "MONEY_REMITTANCE_LICENSED" "MONEY_REMITTANCE_NOT_LICENSED" "PAYMENT_GATEWAY" "PRIVATE_BANKING_LICENSED" "PRIVATE_BANKING_NOT_LICENSED" "PAYMENT_SERVICE_PROVIDER_LICENSED" "PAYMENT_SERVICE_PROVIDER_NOT_LICENSED" "GOVERNMENT" "HOTEL_B_AND_B_GUESTHOUSE_HOSTELS" "IT_SERVICES" "ROYALTIES_AND_OR_LICENSES" "IIPS_AND_VISA_APPLICATION_CONSULTANCY" "LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT" "LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT" "NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT" "NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT" "TRUST_FIDUCIARIES_NOT_LICENSED" "TRUST_FIDUCIARIES_LICENSED" "ANTIQUE_DEALER_AUCTIONEER" "ART_DEALERS" "DESIGNER_APPAREL_AND_CLOTHING" "FASHION_DESIGNERS_CONSULTANTS" "JEWELERS" "WATCHES_AND_COLLECTABLES" "CAR_MANUFACTURING" "ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS" "MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS" "METALLURGY" "PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM" "PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM" "PLASTIC_AND_OTHER_OIL_COMPOUNDS" "TEXTILES" "SALES_MANUFACTURING_OF_VESSELS" "YACHTING_CHARTERING" "BROKER_LICENSED" "BROKER_NOT_LICENSED" "CHIROPRACTORS_LICENSED" "DENTISTS_LICENSED" "GENERAL_MEDICAL_PRACTITIONERS" "HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS" "MEDICAL_LABORATORIES_LICENSED" "VETERINARY_CLINICS" "PRECIOUS_METALS_NON_RAW" "RADIOACTIVE_MATERIALS" "RAW_PRECIOUS_METALS" "NGO_NOT_RECOGNIZED" "NGO_RECOGNIZED" "PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS" "FOOTBALL_CLUBS" "GAMING_GAMBLING_LICENSED_B2B_AND_B2C" "GAMING_GAMBLING_NOT_LICENSED" "GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES" "GAMING_ONLINE_VIDEO_GAMES" "BIOTECH" "MEDICAL_CANNABIS_LICENSED" "NUTRACEUTICALS" "PHARMACEUTICALS_LICENSED" "PHARMACEUTICALS_NOT_LICENSED" "PUBLIC_LISTED_COMPANY" "PROPERTY_MANAGEMENT" "REAL_ESTATE" "WASTE_MANAGEMENT_TECHNOLOGIES" "FUEL_REFINERY_AND_DISTRIBUTION" "ECOMMERCE_TRADER_FOR_GENERAL_GOODS" "FURNITURE_STORES" "GENERAL_APPAREL" "CLEANING_SERVICES" "TRANSLATORS" "CLIENT" "ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES" "TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT" "TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT" "TOBACCO_AND_LIQUORS_LICENSED" "TRAVEL_AGENTS" "BEAUTY_CLINICS_AND_HAIR_SALON" "SPAS" "GYMS_AND_WELLNESS_CENTERS"
object (AddressRequestDto)
object (AddressRequestDto)
object (ExpectedMonthlyExpensesDto)
employeesRange
string

The number of employees working for the corporate.

Enum: "BTW_1_AND_10" "BTW_11_AND_50" "MORE_THAN_50"
lastTermsAccepted
string

The version of the terms and conditions signed by the corporate account owner.

object (Metadata)

A custom field to save data.

This field's size is limited to 3000 characters.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409
500

Internal Server Error

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