Identification-RemoteSelfEmployed-v2

From Barion Documentation
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Barion API: remote KYC identification process for self-employed persons

POST /v2/Identification/RemoteSelfEmployed

The /identification/remoteselfemployed API endpoint is used to complete a remote identification process for a person self-employed under their company (organization) business 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! Any organization (wether company or self-employed) in the Barion system must have their Company Registration Number set before they can undergo remote identification.

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
OrganizationData OrganizationData
  • Required
The details about the organization.
Owner RemoteRepresentative
  • Required
Details about the owner of the company

Output properties

Property name Property type Description
IsSuccessful bool Indicates wether the identification process was successfully completed or not

Possible error responses

Error code Description
UserNotFound The given user was not found in the system
AuthenticationFailed Authentication failed for the given account (incorrect password)
LoginHasWrongAccountType The given account is not an organization account in Barion
IdentificationPending The given account already has a pending identification process
RegistrationNumberMissing The given organization did not provide a registration number in Barion
IdentificationPending The given account already has a pending identification process
InvalidBusinessType The given account is an organization that is not eligible to be identified as self-employed organization (e.g. it has a valid company record)
IncompleteData The given company data was incomplete (owner or organization data missing)
NameIsOnProhibitionList The company owner is on prohibition list. In this case, contact legal authorities!
DocumentsMissing The caller did not provide the personal documents for the identification
DocumentValidityMissing One or more documents that has a mandatory validity did not have the validity set
DocumentExpired One or more supplied document is expired
RemoteIdentificationFailed A general error occured - contact the Barion support

Example

Request

{
  "PartnerKey": "9e9e72fe-96be-4dd3-8957-03e9e1d3f591",
  "ClientEmail": "[email protected]",
  "ClientPassword": "57R0ngP4S5w0RĐ",
  "IdentifierAgent": {
    "FirstName": "Adam",
    "LastName": "Agent",
    "UserName": "adam2017"
  },
  "OrganizationData": {
    "OrganizationName": "TesztTesztTeszt Korlátolt Felelelősségű Társaság",
    "OrganizationShortName": "Teszt Kft.",
    "HeadQuarters_Country": "HUN",
    "HeadQuarters_City": "Budapest",
    "HeadQuarters_Street": "Teszt utca",
    "HeadQuarters_HouseNumber": "1",
    "HeadQuarters_Zip": "1234",
    "PostalAddress_Country": "HUN",
    "PostalAddress_City": "Szeged",
    "PostalAddress_Street": "Dugonics tér",
    "PostalAddress_HouseNumber": "2.",
    "PostalAddress_Zip": "6700"
  },
  "Owner": {
    "FirstName": "Tibor",
    "LastName": "Teszt",
    "BirthFirstName": "Tibor",
    "BirthLastName": "Teszt",
    "MothersFirstName": "Mária",
    "MothersLastName": "Teszt",
    "BirthDate": "1964-02-22T00:00:00",
    "BirthPlace": "Budapest, HU",
    "Nationality": "HUN",
    "Address_Country": "HUN",
    "Address_City": "Budapest",
    "Address_Street": "Test street",
    "Address_HouseNumber": "1",
    "Address_Zip": "12345",
    "Documents": [
      {
        "DocumentType": 1,
        "DocumentNumber": "IDCARD001",
        "DocumentValidUntil": "2025-05-05T00:00:00",
        "DocumentImages": [
          {
            "Data": "\/9j\/4RIuRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAU...", /* example truncated */
            "MimeType": "image\/jpeg"
          }
        ]
      }
    ]
  }
}

Response

{
    "IsSuccessful": true,
    "Errors": []
}