Identification-RemoteCompany-v2: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{PageTitle|title=Barion API: remote KYC identification process for organizations}} {{TableOfContents}} {{api_callmethod |method=POST |uri=/v2/Identification/Remote }} The...") |
|||
| Line 23: | Line 23: | ||
{{api_input_table_header}} | {{api_input_table_header}} | ||
|- | |- | ||
| PartnerKey || Guid || * Required || The secret API key of the trusted partner, generated by Barion. | | PartnerKey || Guid || | ||
* Required | |||
|| The secret API key of the trusted partner, generated by Barion. | |||
|- | |- | ||
| ClientEmail || string || * Required || The e-mail address of the client that is being identified | | ClientEmail || string || | ||
* Required | |||
|| The e-mail address of the client that is being identified | |||
|- | |- | ||
| ClientPassword || string || * Required || The Barion password of the client that is being identified | | ClientPassword || string || | ||
* Required | |||
|| The Barion password of the client that is being identified | |||
|- | |- | ||
| IdentifierName || string || * Required || The name of the agent who is initiating the identification process | | IdentifierName || string || | ||
* Required | |||
|| The name of the agent who is initiating the identification process | |||
|- | |- | ||
| Representatives || [[RemoteRepresentative]][] || * Required || List of representative persons that are connected to the identification process | | Representatives || [[RemoteRepresentative]][] || | ||
* Required | |||
|| List of representative persons that are connected to the identification process | |||
|} | |} | ||
Revision as of 08:14, 16 June 2017
Barion API: remote KYC identification process for organizations
| POST | /v2/Identification/Remote |
|---|
The /identification/remote API endpoint is used to complete a remote identification process for an organization previously registered in the Barion system.
Prerequisites before use:
v2 This API endpoint is available in API v2 only.
partners This API endpoint is available for trusted Barion partners only.
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| PartnerKey | Guid |
|
The secret API key of the trusted partner, generated by Barion. |
| ClientEmail | string |
|
The e-mail address of the client that is being identified |
| ClientPassword | string |
|
The Barion password of the client that is being identified |
| IdentifierName | string |
|
The name of the agent who is initiating the identification process |
| Representatives | RemoteRepresentative[] |
|
List of representative persons that are connected to the identification process |
Output properties
| Property name | Property type | Description |
|---|---|---|
| IsSuccessful | bool | Indicates wether the identification process was successfully completed or not |