By default, all documents uploaded through Core API and DocuPass will be added to the vault. You can disable documents from being saved by setting vault_save to false.

When entries are added to the vault, both Core API and DocuPass API will return a vault entry identifier named vaultid. You can use the identifier to query the content of an entry in the vault by submitting an HTTP POST request to the following endpoint.

https://api.idanalyzer.com/vault/get

Parameters

Successful Response

{
    "success": 1,
    "data": {
        "id": "srGVDvSXxlM3mXgbr5DBP3lw3RXLgFDp",
        "createtime": "2020-05-18 15:49:01",
        "updatetime": "2020-05-18 15:49:01",
        "trustlevel": "0",
        "trustnote": "",
        "docupass_reference": null,
        "docupass_success": null,
        "docupass_failedreason": null,
        "docupass_customid": null,
        "documentNumber": "N123-4567-8888",
        "documentNumber_formatted": "N1234567888",
        "personalNumber": null,
        "firstName": "SAMPLE",
        "middleName": "MIDDLE",
        "lastName": "IDCARD",
        "fullName": "SAMPLE MIDDLE IDCARD",
        "firstName_local": null,
        "middleName_local": null,
        "lastName_local": null,
        "fullName_local": null,
        "dob": "1990-08-08",
        "issued": "2018-06-01",
        "expiry": "2028-06-01",
        "sex": "M",
        "height": "5'-10\"",
        "weight": "158 lbs",
        "hairColor": null,
        "eyeColor": null,
        "address1": "123 EXAMPLE ST",
        "address2": "SOMEPLACE, IL",
        "postcode": "60000",
        "placeOfBirth": null,
        "documentType": "D",
        "documentName": null,
        "vehicleClass": null,
        "restrictions": null,
        "endorsement": null,
        "email": null,
        "mobile": null,
        "landline": null,
        "issueAuthority": null,
        "issuerOrg_region_full": "Illinois",
        "issuerOrg_region_abbr": "IL",
        "issuerOrg_iso2": "US",
        "nationality_iso2": "US",
        "optionalData": "DD 00000000000000",
        "optionalData2": null,
        "customdata1": null,
        "customdata2": null,
        "customdata3": null,
        "customdata4": null,
        "customdata5": null,
        "block": "0",
        "contract": "https:\/\/objects.idanalyzer.com\/9d5f50e20ce90fc99.pdf",
        "image": [
            {
                "id": "2g9NV5a3OWjZ8AwiNqmxH6eLjtlCHZw9",
                "type": "0",
                "hash": "09c4cbe8bc057a735c47d053305f7523",
                "url": "https://objects.idanalyzer.com/v0_2g9NV5a3OWjZ8AwiNqmxH6eLjtlCHZw9.jpg",
                "createtime": "2020-05-18 15:49:01"
            }
        ]
    }

Failed Response

{
    "error": {
        "message": "Document not found",
        "code": 2002
    }
}

Fields

Check below for a list of fields contained in a vault entry. Note that a document may not contain information for every fields, hence some of the field value will be null.

To list all the entries stored inside the vault or search for entries with specific values, send an HTTP POST request to the following endpoint.

https://api.idanalyzer.com/vault/list

Parameters

Example JSON Request

{
    "apikey": "Your API Key",
    "limit": 50,
    "filter": ["createtime>=2020-05-08 00:00:00","createtime<2020-05-09 00:00:00"]
}

Successful Response

The response should include a list of entries and their full content.

{
    "limit": 10,
    "offset": 0,
    "nextoffset": 10,
    "total": 100,
    "items": [
        ...
    ]
}

If no entries are found, items list will be empty.

{
    "total": 0
    "items": []
}

Response Fields

Failed Response

{
    "error": {
        "message": "Invalid filter",
        "code": 2001
    }
}

Pagination

To query the next page of the result, simply use the nextoffset as your offset value, with all other parameters unchanged. If you are on the last page of data, nextoffset field will not be present. To get the total number of pages simply divide total by limit.

You can update the value of a single field or values of multiple fields in a vault entry by making HTTP POST request to:

https://api.idanalyzer.com/vault/update

Parameters

Field Parameters

Simply include the field key and value that you wish to update in your POST request. The field key should be one of the writable fields below:

address1 address2 block customdata1 customdata2 customdata3 customdata4 customdata5 dob documentName documentNumber documentType docupass_customid docupass_failedreason docupass_reference docupass_success email expiry eyeColor firstName firstName_local fullName fullName_local hairColor height issueAuthority issued issuerOrg_iso2 issuerOrg_region_abbr issuerOrg_region_full landline lastName lastName_local middleName middleName_local mobile nationality_iso2 optionalData optionalData2 personalNumber placeOfBirth postcode restrictions sex trustlevel trustnote vehicleClass weight

Example JSON Request

This example will update the first name to "JOHN" and set date of birth to "null".

{
    "apikey": "Your API Key",
    "id":"srGVDvSXxlM3sXgbr5DBP3lw3RXLgFDp",
    "firstName": "JOHN",
    "dob": null
}

Successful Response

{
    "success": 1
}

Failed Response

{
    "error": {
        "message": "Nothing to update",
        "code": 2003
    }
}

You can delete single or multiple vault entries by making HTTP POST request to:

https://api.idanalyzer.com/vault/delete

All images associated with the entry will also be deleted and no longer accessible.

Parameters

Successful Response

{
    "success": 1
}

Failed Response

{
    "error": {
        "message": "Document not found",
        "code": 2002
    }
}

You can upload an image and add it to an existing vault entry by making HTTP POST request to:

https://api.idanalyzer.com/vault/addimage

Parameters

Successful Response

{
    "success": 1,
    "image": {
        "id": "Hx13aULZa1Aikq01yjtTeQGqwMEmPgym",
        "type": "0",
        "hash": "16b0e0b6ed97e9ea79cdd96fc8452e38",
        "url": "https://objects.idanalyzer.com/v5_Hx13aUL3a1Mikq51yjtTeQGqwMEmPgym.jpg",
        "createtime": "2020-05-25 13:01:19"
    }
}

Failed Response

{
    "error": {
        "message": "Invalid value 'image', based64-encoded image data expected.",
        "code": 5
    }
}

You can delete an image inside a vault entry by making HTTP POST request to:

https://api.idanalyzer.com/vault/deleteimage

Note that after an image is deleted, the URL to the image may still be accessible for a short-period of time due to caching.

Parameters

Successful Response

{
    "success": 1
}

Failed Response

{
    "error": {
        "message": "Nothing to update",
        "code": 2003
    }
}

Face search allows you to search the entire vault using an image of a person. To use face search feature, you must enable face search indexing under web portal, and train your vault datasets periodically.

https://api.idanalyzer.com/vault/searchface

Parameters

Successful Response

If matching entries are found, a list of documents with full contents will be returned similar to the list command.

{
    "items": [
        ...
    ]
}

Failed Response

{
    "error": {
        "message": "Vault not trained.",
        "code": 2023
    }
}

Before performing face search, you must issue a train command to train the document datasets inside your vault. You may also train your vault data through web portal.

The training task is asynchronous, training time depends on the number of vault entries and images. It could take from several seconds to an hour.

https://api.idanalyzer.com/vault/train

Parameters

Successful Response

{
    "success": 1
}

Failed Response

{
    "error": {
        "message": "Vault is under training.",
        "code": 5001
    }
}

Check whether vault training is still ongoing or has completed.

https://api.idanalyzer.com/vault/trainstatus

Parameters

Successful Response

{
    "status": "succeeded",
    "startTime": "2020-10-02 15:45:03",
    "statusChangeTime": "2020-10-02 15:45:03",
    "lastSuccessTime": "2020-10-02 15:45:03",
    "error": null
}

Response Fields

Failed Response

{
    "error": {
        "message": "Face search feature is not enabled on your account",
        "code": 5001
    }
}