{"_id":"5715216ab54f5c1900768700","user":"56e62c36cfa58f0e00eafcfb","editedParams":true,"githubsync":"","__v":5,"category":{"_id":"56eb92252109011700f3ba5e","pages":["56eb92af06e2c6190046dc8d","56ebae2543304e2900e21142"],"project":"56e29a8dd3b68d0e00b48ffa","__v":2,"version":"56e29a8dd3b68d0e00b48ffd","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-18T05:29:09.180Z","from_sync":false,"order":7,"slug":"coverage-api","title":"Coverages Lifecycle"},"project":"56e29a8dd3b68d0e00b48ffa","version":{"_id":"56e29a8dd3b68d0e00b48ffd","hasReference":true,"project":"56e29a8dd3b68d0e00b48ffa","__v":15,"hasDoc":true,"createdAt":"2016-03-11T10:14:37.460Z","releaseDate":"2016-03-11T10:14:37.460Z","categories":["56e29a8ed3b68d0e00b48ffe","56eb917a2e58011700afdfcc","56eb92252109011700f3ba5e","5704d4af849f721900f27835","57052a31473f900e004d5d54","5715222811537f19006aab2d","5715b57b810df00e00cc7832","5715baa9810df00e00cc7837","57180ed83a17770e009a7322","571810273a17770e009a7325","579b22d3f4ad7b190094b60e","584538ecba4f1c0f0096925e","586bb88e5602870f00ae7177","5a70407fb0a01400369583c5","5ace359e40606a0003eac1de"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams2":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-18T18:03:22.268Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"<?php\n// Example assumes Composer is in use with GuzzleHttp as the API library.\nrequire_once(\"vendor/autoload.php\");\nuse GuzzleHttp\\Client;\n\nrequire_once(\"functions.php\");\n\n$quoteid = \"191050c8-587b-e2b3-84a5-eeeb6789e02c\"; // your cover ID here\n\n// Create a client and provide a base URL\n$client = new Client([ \n\t'timeout' \t=> 30.0,\n\t'verify'\t=> true,\n\t'debug'\t\t=> true\n]);\n\n\ntry\n{\n\t$response = $client->request('POST', $api_base_uri.\"/claims/$quoteid/attachments\", [\n\t\t'headers' => [ 'apikey' => \"84wHaba2AmfyobvB2M91uIU8d6YOcw6nT\" ], // your API key\n\t\t'multipart' => [\n\t\t\t[\n\t\t\t\t'name'     => 'file',\n\t\t\t\t'contents' => file_get_contents(\"claimtest.pdf\"),\n\t\t\t\t'filename' => \"claimtest.pdf\"\n\t\t\t],\n\t\t],\n\t]);\n\n\t// Check the status code returned by the call\n\t$statusCode = $response->getStatusCode();\n\n\t$data = json_decode($response->getBody(), true);\n\tprint json_encode($data, JSON_PRETTY_PRINT);\n}\ncatch (GuzzleHttp\\Exception\\ClientException $e) {\n    $response = $e->getResponse();\n    $responseBodyAsString = $response->getBody()->getContents();\n\t\n\tprint \"EXCEPTION: response is: \\n\";\n\tprint $responseBodyAsString;\n}\n","language":"php"}]},"method":"post","results":{"codes":[{"code":"{\n    \"id\": \"191050c8-587b-e2b3-84a5-eeeb6789e02c\",\n    \"status\": \"Claimed\",\n    \"coverage\": {\n        \"currency\": \"EUR\",\n        \"quotedAt\": \"2017-01-24T09:28:53Z\",\n        \"duration\": 60,\n        \"bpsperday\": 0.05170435\n    },\n    \"sellerId\": \"606262ca-7d40-09f7-d46b-57cf519e29fd\",\n    \"buyerId\": \"a53b0670-e152-4177-971b-ddf4835195d5\",\n    \"invoice\": {\n        \"Amount\": 1111,\n        \"Currency\": \"EUR\",\n        \"DueAt\": \"2017-03-24T09:28:53Z\",\n        \"IssuedAt\": \"2017-01-24T09:28:53Z\",\n        \"Number\": \"TEST1497346133\"\n    }\n}\n","language":"json","status":200,"name":""},{"name":"","code":"{\n\t\"message\" : \"Missing parameters\",\n  \"docUrl\": \"https://armadill.io/docs/errors#section-missing_param\"\n}","language":"json","status":400},{"code":"{\n\t\"message\" : \"Resource not found\",\n  \"docUrl\": \"https://armadill.io/docs/errors#section-resource_not_found\"\n}","language":"json","status":404},{"status":401,"code":"{\n\t\"message\" : \"Bad authentication information\",\n  \"docUrl\": \"http://docs.armadill.io/docs/errors#section-bad-authentication-information\"\n}","language":"json"},{"language":"json","status":408,"code":"{\n\t\"message\" : \"Expired date stamp\",\n  \"docUrl\": \"https://armadill.io/docs/authentication\"\n}"}]},"settings":"","auth":"required","params":[{"_id":"56e98c69cbeede0e0006e56d","ref":"","in":"path","required":true,"desc":"The cover ID the claim request is for.","default":"","type":"string","name":"id"},{"_id":"579e5630f8b52d0e0043fd18","ref":"","in":"header","required":true,"desc":"Your Coverage API Key, in the HTTP request headers.","default":"","type":"string","name":"apikey"}],"url":"/claims/:coverid/attachments"},"isReference":true,"order":2,"body":"The claim endpoint allows you to upload the standard claims form PDF. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"This endpoint is still under development; claims are currently processed through a workflow outside of the API as we finalise the new, improved, API-driven claims process.\"\n}\n[/block]\nThe PDF should be filled out with all the required information and then uploaded as a file (via the  usual POST-based multipart upload mechanism). \n\nOnce the form has been successfully uploaded, it will be delivered to the claims team and the claims process will begin. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Claims Form\",\n  \"body\": \"The claims process is currently still under active development; the process various slightly from country to country and as a result some customisation may be required depending on your region. \\n\\nThe claims process described here is for policies based in France. \\n\\nThe French claims form is available [download here](https://developer.single-invoice.co/forms/claim-form.pdf).\"\n}\n[/block]\nFile attachment rules: \n\n- filename must not only include letters, numbers, _ and a single \".\" character for the extension\n- filename must not be longer than 30 characters\n- file should be between 1kb and 2MB\n- file type must be PDF","excerpt":"Initiates a claim against a coverage policy.","slug":"claim","type":"endpoint","title":"Claim Cover [not yet implemented]"}

postClaim Cover [not yet implemented]

Initiates a claim against a coverage policy.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The cover ID the claim request is for.

Headers

apikey:
required
string
Your Coverage API Key, in the HTTP request headers.

Examples


Result Format


Documentation

The claim endpoint allows you to upload the standard claims form PDF. [block:callout] { "type": "warning", "body": "This endpoint is still under development; claims are currently processed through a workflow outside of the API as we finalise the new, improved, API-driven claims process." } [/block] The PDF should be filled out with all the required information and then uploaded as a file (via the usual POST-based multipart upload mechanism). Once the form has been successfully uploaded, it will be delivered to the claims team and the claims process will begin. [block:callout] { "type": "info", "title": "Claims Form", "body": "The claims process is currently still under active development; the process various slightly from country to country and as a result some customisation may be required depending on your region. \n\nThe claims process described here is for policies based in France. \n\nThe French claims form is available [download here](https://developer.single-invoice.co/forms/claim-form.pdf)." } [/block] File attachment rules: - filename must not only include letters, numbers, _ and a single "." character for the extension - filename must not be longer than 30 characters - file should be between 1kb and 2MB - file type must be PDF