Identification-RemoteCompany-v2: Difference between revisions
Jump to navigation
Jump to search
Line 68: | Line 68: | ||
"UserName": "adam2017" | "UserName": "adam2017" | ||
}, | }, | ||
"CompanyRegisterId": "8c2f52da-dd17-42f4-83b6-95a3847c3924", | |||
"Representatives": [ | "Representatives": [ | ||
{ | { |
Revision as of 07:13, 3 July 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 |
IdentifierAgent | IdentifierAgent |
|
Information about the agent who is initiating the identification process |
CompanyRegisterId | Guid |
|
The public identifier of the register data associated with the company. This is received by making an API call to the the Identification-Information-v2 endpoint first. |
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 |
Example
Request
{
"PartnerKey": "9e9e72fe-96be-4dd3-8957-03e9e1d3f591",
"ClientEmail": "[email protected]",
"ClientPassword": "57R0ngP4S5w0RĐ",
"IdentifierAgent": {
"FirstName": "Adam",
"LastName": "Agent",
"UserName": "adam2017"
},
"CompanyRegisterId": "8c2f52da-dd17-42f4-83b6-95a3847c3924",
"Representatives": [
{
"FirstName": "John",
"LastName": "Smith",
"IsRealOwner": true,
"Documents": [
{
"DocumentType": 1,
"DocumentNumber": "IDCARD001",
"DocumentValidUntil": "2025-05-05T00:00:00",
"DocumentImages": [
{
"Data": "/9j/4RIuRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgE...", /* example truncated */
"MimeType": "image/jpeg"
}
]
}
]
}
]
}
Response
{
"IsSuccessful": true,
"Errors": []
}