Identification-RemoteCompany-v2: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
No edit summary
No edit summary
Line 17: Line 17:


<span class="api-ver">partners</span> This API endpoint is available for '''trusted Barion partners''' only.
<span class="api-ver">partners</span> This API endpoint is available for '''trusted Barion partners''' only.
== Prerequisites and constraints ==
'''IMPORTANT!'''
This API call requires that the caller has previously sent a request to the [[Identification-Information-v2]] endpoint with valid authentication data for the organization, so they obtain the <code>CompanyRegisterId</code> parameter which is required for this endpoint.
The [[Identification-Information-v2]] call result also contains information about the representative personnel of the company and their [[Signatory status]]. The list of representative personnel included in the call to this API endpoint must match the data received in the previous call, and the combination of the provided personnel must comply with the company's signatory regulations. Otherwise an exception message is thrown.


== Input properties ==
== Input properties ==

Revision as of 07:23, 3 July 2017

Barion API: remote KYC identification process for organizations

POST /v2/Identification/RemoteCompany

The /identification/remotecompany API endpoint is used to complete a remote identification process for a company (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.

Prerequisites and constraints

IMPORTANT! This API call requires that the caller has previously sent a request to the Identification-Information-v2 endpoint with valid authentication data for the organization, so they obtain the CompanyRegisterId parameter which is required for this endpoint. The Identification-Information-v2 call result also contains information about the representative personnel of the company and their Signatory status. The list of representative personnel included in the call to this API endpoint must match the data received in the previous call, and the combination of the provided personnel must comply with the company's signatory regulations. Otherwise an exception message is thrown.

Input properties

Property name Property type Limitations and constraints Description
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
ClientPassword string
  • Required
The Barion password of the client that is being identified
IdentifierAgent IdentifierAgent
  • Required
Information about the agent who is initiating the identification process
CompanyRegisterId Guid
  • Required
The public identifier of the register data associated with the organization. This is received by making an API call to the the Identification-Information-v2 endpoint first.
Representatives RemoteRepresentative[]
  • Required
List of representative persons for the organization being identified
RealOwners RemoteRealOwner[]
  • Required
List of the real owners of the organization being identified

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": []
}