🗃️Return All Identity Documents

Retrieve all the Identity Document Records on your unique Gathr database.

Return All Identity Documents

GET {{baseUrl}}/identity-documents

Retrieve all of the Identity Document Records available on your tenant_id

Path Parameters

Name	Type	Description
tenantId*	String	This is the tenantId that was assigned to you when your tenant was created. You will have received this information via message from a member of the Finch Technologies team. If you can't find it, please email [e-mail].
environmentUrl*	String	https://uat.apply.fincheck.co.za This is the environment URL for uat. Once you change over to prod, you would have to use: https://apply.fincheck.co.za. *Please note that you need to be set up in each environment by a member of the Finch Technologies team, who will share your bearer token with you for the specific environment in a protected link.

200: OK Returned All Identity Documents

```postman_json
{
    "data": [
        {
            "id": "{{identityId}}",
            "type": "drivers_licence",
            "front": {
                "id": 1029,
                "name": "KJH Front.jpeg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/KJH%20Front.jpeg"
            },
            "back": {
                "id": 1030,
                "name": "KJH_Back.jpeg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/KJH_Back.jpeg"
            },
            "valid": false
        },
        {
            "id": "{{identityId}}",
            "type": "drivers_licence",
            "front": {
                "id": 1027,
                "name": "KJH Front.jpeg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/KJH%20Front.jpeg"
            },
            "back": null,
            "valid": false
        },
        {
            "id": "{{identityId}}",
            "type": "id_card",
            "front": {
                "id": 1025,
                "name": "KirstenIDCard_Front.jpeg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/KirstenIDCard_Front.jpeg"
            },
            "back": {
                "id": 1026,
                "name": "Kirsten_IDCard_Back.jpeg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/Kirsten_IDCard_Back.jpeg"
            },
            "valid": false
        },
        {
            "id": "{{identityId}}",
            "type": "drivers_licence",
            "front": {
                "id": 1023,
                "name": "KJH Front.jpeg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/KJH%20Front.jpeg"
            },
            "back": {
                "id": 1024,
                "name": "KJH_Back.jpeg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/KJH_Back.jpeg"
            },
            "valid": true
        },
        {
            "id": "{{identityId}}",
            "type": "id_card",
            "front": {
                "id": 1021,
                "name": "KirstenIDCard_Front.jpeg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/KirstenIDCard_Front.jpeg"
            },
            "back": {
                "id": 1022,
                "name": "Kirsten_IDCard_Back.jpeg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/Kirsten_IDCard_Back.jpeg"
            },
            "valid": true
        },
        {
            "id": "{{identityId}}",
            "type": "id_book",
            "front": {
                "id": 1020,
                "name": "KJH_IDBook_Grey_1page.jpg",
                "type": "jpg",
                "url": "http://uat.apply.fincheck.co.za/cash-advance/documents/KJH_IDBook_Grey_1page.jpg"
            },
            "back": null,
            "valid": true
        },
        {
            "id": "{{identityId}}",
            "type": "drivers_licence",
            "front": null,
            "back": null,
            "valid": false
        },
        {
            "id": "{{identityId}}",
            "type": "id_card",
            "front": null,
            "back": null,
            "valid": false
        },
        {
            "id": "{{identityId}}",
            "type": "id_book",
            "front": null,
            "back": null,
            "valid": false
        }
    ],
    "meta": {
        "total": 9,
        "count": 9,
        "per_page": 15,
        "current_page": 1,
        "total_pages": 1
    }
}
```