Latest Legacy

    List all Identities

    Returns a list of Identities.

    API Endpoint

    GET https://api.plivo.com/v1/Account/{auth_id}/Verification/Identity/

    Arguments

    country_iso

    Country ISO 3166 alpha-2 code.

    customer_name

    Name of the customer or business that’s mentioned in the address.

    alias

    Friendly name of the ID proof.

    verification_status

    The status of the identity. Allowed values: approved, pending, rejected.

    Returns

    An array of Identity objects.

    Response

    HTTP Status Code: 200

    {
  "api_id": "3c294e0c-0b5a-11e8-9ad8-064c8d7b2d26",
  "meta": {
    "limit": 1,
    "next": "https://api.plivo.com/v1/Account/MAXXXXXXXXXXXXXXXXXX/Verification/Identity/?limit=1&offset=1",
    "offset": 0,
    "previous": null,
    "total_count": 6
  },
  "objects": [
    {
      "account": "MAXXXXXXXXXXXXXXXXXX",
      "alias": null,
      "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"
    }
  ]
}

    Example Request

    1
2
3
4
5
6
7

    import plivo

client = plivo.RestClient('<auth_id>','<auth_token>')
response = client.identities.list(
    offset=0,
    limit=5, )
print(response)

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

    /**
 * Example for Account Get
 */
using System;
using System.Collections.Generic;
using Plivo;
using Plivo.Exception;

namespace PlivoExamples
{
    internal class Program
    {
        public static void Main(string[] args)
        {
            var api = new PlivoApi("<auth_id>","<auth_token>");
            try
            {
                var response = api.Identity.List();
                Console.WriteLine(response);
            }
            catch (PlivoRestException e)
            {
                Console.WriteLine("Exception: " + e.Message);
            }
        }
    }
}