{"_id":"56eb8a7b1633510e00f884fa","githubsync":"","parentDoc":null,"editedParams":true,"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"},"__v":3,"editedParams2":true,"project":"56e29a8dd3b68d0e00b48ffa","user":"56e62c36cfa58f0e00eafcfb","category":{"_id":"5715baa9810df00e00cc7837","project":"56e29a8dd3b68d0e00b48ffa","__v":0,"version":"56e29a8dd3b68d0e00b48ffd","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-04-19T04:57:13.380Z","from_sync":false,"order":6,"slug":"coverage","title":"Covers"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-18T04:56:27.668Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n    \"Id\": \"653ba175-f5e2-4889-9ebc-4b0b369b6f39\",\n    \"Status\": \"Rejected\",\n    \"RejectedBy\": \"User\",\n    \"Coverage\": {\n        \"Amount\": 211.5,\n        \"Currency\": \"gbp\",\n        \"RejectedAt\": \"2016-08-12T10:07:16Z\"\n    },\n    \"SellerId\": \"fdb3990c-b34e-4790-8233-b79358349e6c\",\n    \"BuyerId\": \"b7663697-6c94-42b2-a11a-d842aa5ccdfa\",\n    \"Invoice\": {\n        \"Amount\": 97322.02,\n        \"Currency\": \"gbp\",\n        \"DueAt\": \"2016-10-10T00:00:00Z\",\n        \"IssuedAt\": \"2016-08-10T00:00:00Z\",\n        \"Number\": null\n    }\n}","language":"json","status":200},{"status":400,"name":"","code":"{\n\t\"message\" : \"Missing parameters\",\n  \"docUrl\": \"https://armadill.io/docs/errors#section-missing_param\"\n}","language":"json"},{"code":"{\n\t\"message\" : \"Bad authentication information\",\n  \"docUrl\": \"http://docs.armadill.io/docs/errors#section-bad-authentication-information\"\n}","language":"json","status":401},{"language":"json","status":404,"code":"{\n\t\"message\" : \"Resource not found\",\n  \"docUrl\": \"https://armadill.io/docs/errors#section-resource_not_found\"\n}"},{"code":"{\n\t\"message\" : \"Expired date stamp\",\n  \"docUrl\": \"https://armadill.io/docs/authentication\"\n}","language":"json","status":408}]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[{"_id":"56eb8ae72e58011700afdfc4","ref":"","in":"path","required":true,"desc":"The Coverage ID","default":"","type":"string","name":"id"},{"_id":"579e4f6e8cc49e0e00dea8c4","ref":"","in":"header","required":true,"desc":"Your Coverage API Key, in the HTTP request headers.","default":"","type":"string","name":"apikey"}],"url":"/coverage/:id"},"isReference":true,"order":1,"body":"Use Get by [Get by Single-Invoice.co ID](doc:companybyid)  to retrieve information on the buyer and seller.\n\n##Coverage Status\n\nEach coverage policy has an associated status:\n\n- `active` - indicates the policy is currently active\n- `settled` - indicates a policy was settled successfully and is no longer needed.  It is not possible to activate a settled policy.\n- `cancelled` - indicates the policy has been cancelled. It is not possible to activate a cancelled policy.\n- `rejected` - indicates the policy has been rejected. It is not possible to activate a rejected policy.\n- `pending` - indicates the policy is pending activation. \n- `expired` - indicates the policy has expired. It is not possible to activate an expired policy.\n- `overdue` - indicates the policy has been declared overdue and a claim has been filed.\n- `claimed` - indicates the policy's claim was successful\n\nEach policy also contains a list of transactions that have occurred in the lifecycle of this policy. They include:\n\n- `activated` -indicates that the policy was activated\n- `resolved` -indicates the policy was resolved\n- `cancelled` -indicates the policy was cancelled\n- `rejected` -indicates the policy was rejected","excerpt":"Returns information about a Coverage policy, including a list of  [transaction IDs](get-by-id) identifying policy status changes.","slug":"coverage-by-id","type":"endpoint","title":"Get Cover By ID"}

getGet Cover By ID

Returns information about a Coverage policy, including a list of [transaction IDs](get-by-id) identifying policy status changes.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The Coverage ID

Headers

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

Result Format


Documentation

Use Get by [Get by Single-Invoice.co ID](doc:companybyid) to retrieve information on the buyer and seller. ##Coverage Status Each coverage policy has an associated status: - `active` - indicates the policy is currently active - `settled` - indicates a policy was settled successfully and is no longer needed. It is not possible to activate a settled policy. - `cancelled` - indicates the policy has been cancelled. It is not possible to activate a cancelled policy. - `rejected` - indicates the policy has been rejected. It is not possible to activate a rejected policy. - `pending` - indicates the policy is pending activation. - `expired` - indicates the policy has expired. It is not possible to activate an expired policy. - `overdue` - indicates the policy has been declared overdue and a claim has been filed. - `claimed` - indicates the policy's claim was successful Each policy also contains a list of transactions that have occurred in the lifecycle of this policy. They include: - `activated` -indicates that the policy was activated - `resolved` -indicates the policy was resolved - `cancelled` -indicates the policy was cancelled - `rejected` -indicates the policy was rejected