Fetch Policies

How to get the data

Get all Policies

Paginated list of all policies

GET https://app.insurehero.io/api/shield/v1/policies

Headers

Name	Type	Description
Authorization*	string	Bearer access token

Query Parameters

Name	Type	Description
searchBy	id | uid	Field use to search for a matching policy. Default to 'id'
holderId	id | uid	Use the unique identifier of the policy holder to search for a matching policy.

Example response

200: OK Retrieved successfully

{
    "data": [
        {
            "id": "9e1149b7-341f-4401-bb93-b8cff2bd22c6",
            "version": 23,
            "channel_id": "ec6d8093-2441-4c0a-9c78-1a28efb200cc",
            "holder_id": "0ff04f47-3b1a-4e3f-8581-ac05f3dc2203",
            "uid": "122775",
            "max_rescission_window": "0",
            "policy_number": "122775",
            "coverages": {
                "Seguro de vehiculos personales": [
                    {
                        "id": "05f2bd54-66b6-4617-b387-3d37a4952d58",
                        "insurer": {
                            "id": "01edbc3a-1f32-4013-91c8-2f054f236714",
                            "name": "AIG"
                        },
                        "variant": {
                            "id": "0d24c04a-dce7-4082-9ba6-238d1b5adde5",
                            "name": "Seguros vehiculares personales",
                            "claim_schema": {}
                        }
                    }
                ]
            },
            "metadata": {},
            "attachments": [
                "https://bkrxyxqcthcbzmhwwzef.supabase.co/storage/v1/object/public/policies/ec6d8093-2441-4c0a-9c78-1a28efb200cc/122775/OT209497_QUITO_VEHICULOS%20PERSONALES_122775_542709%20Original%202.pdf"
            ],
            "features": []
        }
    ]
}

400: Bad Request Request contains malformed data

401: Unauthorized Invalid or expired access token

402: Payment Required Pending payment

422: Unprocessable Entity Internal validation failed

429: Too Many Requests API rate limit

404: Not Found User not found

Get the data of a given Policy

GET https://app.insurehero.io/api/shield/v1/policy/:policyNumber

Headers

Name	Type	Description
Authorization*	string	Bearer access token

Path Parameters

Name	Type	Description
policyNumber*	string	Policy number

Example response

200: OK Retrieved successfully

{
    "data": {
        "id": "9e1149b7-341f-4401-bb93-b8cff2bd22c6",
        "version": 23,
        "channel_id": "ec6d8093-2441-4c0a-9c78-1a28efb200cc",
        "holder_id": "0ff04f47-3b1a-4e3f-8581-ac05f3dc2203",
        "uid": "122775",
        "max_rescission_window": "0",
        "policy_number": "122775",
        "coverages": {
            "Seguro de vehiculos personales": [
                {
                    "id": "05f2bd54-66b6-4617-b387-3d37a4952d58",
                    "insurer": {
                        "id": "01edbc3a-1f32-4013-91c8-2f054f236714",
                        "name": "AIG"
                    },
                    "variant": {
                        "id": "0d24c04a-dce7-4082-9ba6-238d1b5adde5",
                        "name": "Seguros vehiculares personales",
                        "claim_schema": {}
                    }
                }
            ]
        },
        "metadata": {},
        "attachments": [
            "https://bkrxyxqcthcbzmhwwzef.supabase.co/storage/v1/object/public/policies/ec6d8093-2441-4c0a-9c78-1a28efb200cc/122775/OT209497_QUITO_VEHICULOS%20PERSONALES_122775_542709%20Original%202.pdf"
        ],
        "features": []
    }
}

400: Bad Request Request contains malformed data

401: Unauthorized Invalid or expired access token

402: Payment Required Pending payment

422: Unprocessable Entity Internal validation failed

429: Too Many Requests API rate limit

404: Not Found User not found

To access these resources, please remember to visit the Links and Resources section of the documentation.