Identification-Information-v2

From Barion Documentation
Revision as of 07:41, 9 August 2017 by Vinczei (talk | contribs) (Possible error responses)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Barion API: Fetch information about an organization

GET /v2/Identification/Information

The /identification/information API endpoint is used to fetch information about an organization for the remote identification process.

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
  • Required
The secret API key of the trusted partner, generated by Barion.
Email string
  • Required
The e-mail address of the organization in Barion
Password string
  • Required
The password of the organization in Barion

Output properties

Property name Property type Description
CompanyRegisterInfo CompanyRegisterInfo A bundle object containing the detailed information about the organization

Possible error responses

Error code Description
NoIdentifiedPartnerFound The given partner key was not valid
PartnerDataCannotBeRetrieved The trusted partner data could not be retrieved (possibly has no rights for this endpoint)
AuthenticationFailed Authentication failed for the target organization (incorrect login name or password)
RemoteRegisterInfoReturnedWithError The company register service returned an error
RegisterInfoCannotBeRetrievedFromDb The company register record could not be retrieved from the Barion database. Please contact the Barion support.
RegisterInfoCannotBeRetrievedFromRemote The company register record could not be retrieved from the remote service. Possible causes:
  • The given company is not based in Hungary (there is no service to call)
  • The company register remote service is down
CompanyRegisterDoesNotExistsForCountry No company register service exists for the organization's country

Example

Request

https://api.barion.com/v2/identification/information?PartnerKey=630ee026-3e19-469f-8325-afc9bd1ae6a6&[email protected]&Password=5tr0Ng_Pa55w0rD

Response

{
    "CompanyRegisterInfo": {
        "RegistrationNumber": "12345678-1234",
        "OrganizationName": "Barion Payment Zrt.",
        "OrganizationShortName": "Barion Payment Zrt.",
        "HeadQuarter": {
            "Address": "1117 Budapest, Infopark sétány 1. I épület",
            "Country": "Magyarország",
            "CountryCode": "HU",
            "Zip": "1117",
            "City": "Budapest",
            "Street": "Infopark sétány",
            "Housenumber": "1. I épület 5. emelet"
        },
        "PostalAddress": {
            "Address": "1117 Budapest, Infopark sétány 1. I épület",
            "Country": "Magyarország",
            "CountryCode": "HU",
            "Zip": "1117",
            "City": "Budapest",
            "Street": "Infopark sétány",
            "Housenumber": "1. I épület 5. emelet"
        },
        "MainActivity": "Egyéb szoftverkiadás",
        "MainActivityCodde": "5829",
        "TaxNumber": "00112233",
        "Branch": "00112233",
        "Ownership": "Zártkörűen működő részvénytársaság",
        "RegisteredAt": "2015-09-01T00:00:00",
        "DeletedAt": "0001-01-01T00:00:00",
        "DeletionMode": null,
        "Note": null,
        "Representatives": [
            {
                "RepresentationMode": "Meghatalmazott",
                "CanSign": true,
                "Office": "végelszámoló",
                "Email": "[email protected]",
                "Person": {
                    "FullName": "Teszt Tibor",
                    "LastName": "Teszt",
                    "FirstName": "Tibor",
                    "BirthDate": "1978-05-23T00:00:00.000",
                    "MothersName": "Teszt Teréz",
                    "MothersLastName": "Teszt",
                    "MothersFirstName": "Teréz",
                    "TaxNumber": "9955884466",
                    "Address": {
                        "Address": "1134 Budapest, Szilágyi utca 2.",
                        "Country": "Magyarország",
                        "CountryCode": "HU",
                        "Zip": "1134",
                        "City": "Budapest",
                        "Street": "Szilágyi utca",
                        "Housenumber": "2."
                    },
                    "AddressString": "1134 Budapest, Szilágyi utca 2."
                }
            }
        ],
        "Members": [
            {
                "Person": {
                    "FullName": "Példa Péter",
                    "LastName": "Példa",
                    "FirstName": "Péter",
                    "BirthDate": "1980-12-03T00:00:00.000",
                    "MothersName": "Péda Panna",
                    "MothersLastName": "Példa",
                    "MothersFirstName": "Panna",
                    "TaxNumber": "001122889977",
                    "Address": {
                        "Address": "1152 Budapest, Kossuth utca 35.",
                        "Country": "Magyarország",
                        "CountryCode": "HU",
                        "Zip": "1152",
                        "City": "Budapest",
                        "Street": "Kossuth utca",
                        "Housenumber": "35."
                    },
                    "AddressString": "1152 Budapest, Kossuth utca 35."
                }
            }
        ]
    }
}