Create onboarding Application

Creates Application for onboarding Customer.

Endpoint

Request Type	URL
POST	https://{EnvironmentURL}/public/kycp/applications

Headers

Parameter	Type	Mandatory	Description
x-api-version	string	Yes	Requested API version – 1.0
Content-Type	string	Yes	application/json

Request body

Body - JSON

Application, root entity

Parameter	Type	Mandatory	Description
programId	int	Mandatory	Program Numeric Identifiers. Available values: 1 – Main program
entities	Collection	Mandatory	Collection of objects of type Entity. Method accepts only one root Entity. This root entity must be Individual or Company

Parameter

Type

Mandatory

Description

programId

int

Mandatory

Program Numeric Identifiers.

Available values:

1 – Main program

entities

Collection

Mandatory

Collection of objects of type Entity.

Method accepts only one root Entity.

This root entity must be Individual or Company

Entity

Parameter	Type	Mandatory	Description
typeId	int	Non Mandatory	Numeric Identifier of the Type of the Entity. Available Types: 27 – Individual 12 - Company
entities	Collection	Non Mandatory	Collection of sub-entities. Available only in case when type of root entity is Company. Sub-entities can be: Individuals – representatives of onboarding Company. Individuals or Companies – shareholders of the onboarding Company. Each Company-shareholder can have its own sub-entities
fields	Collection	Mandatory	Collection of properties of the Entity – Key-Value pairs

Parameter

Type

Mandatory

Description

typeId

int

Non Mandatory

Numeric Identifier of the Type of the Entity.

Available Types:

27 – Individual
12 - Company

entities

Collection

Non Mandatory

Collection of sub-entities.

Available only in case when type of root entity is Company.

Sub-entities can be:

Individuals – representatives of onboarding Company.
Individuals or Companies – shareholders of the onboarding Company. Each Company-shareholder can have its own sub-entities

fields

Collection

Mandatory

Collection of properties of the Entity – Key-Value pairs

View detailed list of fields for Individual Entity

View detailed list of fields for Company Entity

View example of the Application Request

Responses

200 OK - Success

Parameter	Type	Mandatory	Description
Application	object	Yes	Created Application

In returned Application object will be provided following identifiers:

Parameter	Type	Mandatory	Description
id	int	Yes	Numeric identifier of created Application
uid	string	Yes	String identifier of created Application

Application will be handled by DigiDoe services and result will be provided in a Webhook

Returned identifiers can be used to match data on Client side

Additionally, for each created Entity under Application will be provided following identifiers:

Parameter	Type	Mandatory	Description
id	int	Yes	Numeric identifier of created Entity
applicationEntityId	int	Yes	Numeric identifier of created Entity-Application relation

Last modified: 22 января 2024