The Identity object

    Attributes

    id

    Unique identifier for the Identity object.

    country_iso

    Country ISO 3166 alpha-2 code.

    alias

    Alias name of the address.

    salutation

    Allowed values: Mr, Ms

    first_name

    First name of the user for whom the identity is created.

    last_name

    Surname of the user for whom the identity is created.

    birth_place

    Birthplace of the user.

    birth_date

    Birth date in yyyy-mm-dd format of the user.

    nationality

    Nationality of the user.

    id_nationality

    Nationality mentioned in the identity proof.

    id_issue_date

    Issue date in yyyy-mm-dd format of the identity proof.

    business_name

    Business name of the user.

    id_type

    Building name/number.

    id_number

    Unique number on the identifier.

    address_line1

    Building name/number.

    address_line2

    Street name/number.

    city

    The city of the address.

    region

    The region of the address.

    postal_code

    The postal code of the address.

    fiscal_identification_code

    The code is available for businesses alone and is available for Spain mobile numbers. Return null if not present.

    street_code

    Street code of the address. Return null if not present.

    municipal_code

    Municipal code of the address. Return null if not present.

    validation_status

    Allowed values: pending, accepted, rejected, null.

    verification_status

    Allowed values: pending, verified, rejected.

    subaccount

    Link to the subaccount resource associated with the application. If the application belongs to the main account, this field will be null.

    url

    A Plivo wrapped link to the document stored in the Plivo CDN.

    Response

    {
      "account": "MAXXXXXXXXXXXXXXXXXX",
      "alias": null,
      "api_id": "6e951a10-0b5a-11e8-a416-06f8d2f9b24c",
      "country_iso": "FR",
      "document_details": {
        "first_name": "Bruce",
        "id_number": "33522",
        "id_type": "passport",
        "last_name": "Wayne",
        "nationality": "FR",
        "salutation": "Mr"
      },
      "first_name": "Bruce",
      "id": "24856289978366",
      "id_number": "33522",
      "id_type": "passport",
      "last_name": "Wayne",
      "nationality": "FR",
      "salutation": "Mr",
      "subaccount": null,
      "url": "https://api.plivo.com/v1/Account/MAXXXXXXXXXXXXXXXXXX/Verification/Identity/24856289978366/",
      "validation_status": "pending",
      "verification_status": "pending"
    }