Retrieve Customer’s Information

By using this method an external system receives information about the customer. The content of the information is categorized. In the Authorization Url's scope parameter the client should specify an information category code, on which they want a customer to give a consent to share. The following categories can be chosen:

• FPI (Full personal info) – Full personal info
• DI (Document Info) - Document Info
• BI (Birth info) - Birth info
• CI (Contact Info) - Contact Info
• BPI (Basic personal info) - Basic personal info
• PI (Personal Info) – Personal Info

The below information can be received in the Json format on request for a customer’s registration data. You may see the data categorization in the below table:

		FPI	DI	BPI	PI	BI	CI
firstName	First name	✅		✅	✅
lastName	Last name	✅		✅	✅
pin	An Identification Number	✅			✅
citizenshipCountry	Customer’s citizen country (ISO Alpha-2 code)	✅			✅
sex	Gender	✅		✅	✅
birthDate	Date of birth	✅				✅
birthCountry	Customer’s birth country (ISO Alpha-2 code)	✅				✅
birthPlace	Customer’s birth city	✅				✅
photo	Photo in Base64 format	✅			✅
type	A document type	✅	✅
docNo	A document number	✅	✅
issueDate	A document issue date	✅	✅
issuerCountry	A document issuer country	✅	✅
issuer	A document issuer organization	✅	✅
expiryDate	A document expiration date	✅	✅
homeAddress	Customer’s home address						✅
actualAddress	Customer’s actual address						✅
phone	Phone number						✅
mail	Customer’s email						✅

Header

Content-Typerequiredapplication/json

AuthorizationrequiredBearer <jwt_token>

Bearer <jwt_token>, where the jwt_token is a value returned in an access_token parameter from the Authentication Method Response

channeloptionalString

client_id of the company

operationIdrequiredString

A unique identifier of Operation, generated by a company

REQUEST

GET https://bogid.bog.ge/v1/customer-data
Content-Type: application/json
Authorization: Bearer <jwt_token>
channel: "123456",
operationId: "123456"

Response

resultCodeString

Result code of operation. 0 – if operation completed successfully.

errorKey String

Error code.

errorMessageString

Error description

userDataObject

Customer’s information

firstNameString

Name

lastNameString

Surname

birthDateDate

Date of birth

pinString

An Identification Number

identityDocumentArray

A document array with the following attributes

typeString

A document type

docNoString

A document number

issueDateDate

A document issue date

issuerCountryString

A document issuer country

issuerString

A document issuer organization

expiryDateDate

A document expiration date

sexString

Gender

citizenshipCountryString

Customer’s citizen country (ISO Alpha-2 code)

birthCountryString

Customer’s birth country (ISO Alpha-2 code)

birthPlaceString

Birth city

homeAddressString

Customer’s home address

actualAddressString

Customer’s actual address

photoString

Photo in Base64 format

phoneString

Phone number

mailString

Customer’s email

RESPONSE

{
  "resultCode": "String",
  "errorKey ": "String",
  "errorMessage": "String",
  "userData": {
      "firstName": "String",
      "lastName": "String",
      "birthDate": "Date",
      "pin": "String",
      "identityDocument" : [
          {
            "type": "String",
            "docNo": "String",
            "issueDate":  "Date",
            "issuerCountry":  "String",
            "issuer":  "String",
            "expiryDate": "Date"
          },
          {
            "type": "String",
            "docNo": "String",
            "issueDate":  "Date",
            "issuerCountry":  "String",
            "issuer":  "String",
            "expiryDate": "Date"
          }
      ],
      "sex": "String",
      "citizenshipCountry" : "String",
      "birthCountry": "String",
      "birthPlace": "String",
      "homeAddress": "String",
      "actualAddress": "String",
      "photo": "String",
      "phone": "String",
      "mail": "String",

  }
}