Create/Update Onboarding Application

POST

https://{EnvironmentURL}/kycp/applications

x-api-version

string

Yes

Requested API version – 1.0

Content-Type

string

Yes

application/json

id

String

Non Mandatory

Numeric Identifier of the Application

Mandatory in case of update (For update either id or uid must be filled)

customerId

String

Mandatory

Identifier of the Customer who will be onboarded

uid

String

Non Mandatory

String Identifier of of the Application

Mandatory in case of update (For update either id or uid must be filled)

programId

int

Mandatory

Program Numeric Identifiers.

Available values:

1 – Main program

finalized

bool

Mandatory

Must be True in case when all data of the application filled and Compliance service can start process of approvement

entities

Collection

Mandatory

Collection of objects of type Entity.

Method accepts only one root Entity.

This root entity must be Individual or Company

id

int

Non Mandatory

Numeric Identifier of the Entity

Mandatory in case of update

applicationEntityId

int

Non Mandatory

Numeric Identifier of the Entity-Application link.

Mandatory in case of update

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