CrowBar | Get Policy Documents | Corvus Skip to main content

Product: Smart Cyber

Get Policy Documents

GetPolicyDocuments($clientId: ID!)
Product
Smart Cyber
Method
POST
Endpoint
Sandbox: https://api-sandbox.corvusinsurance.com/q Production: https://crowbar.corvusinsurance.com/q
Authentication
Send the headers X-API-KEY, X-USER-EMAIL, X-USER-NAME with every request. See Authentication.
After requesting the bind, an underwriter will manually generate the binder and invoice and add them to the client's account. This is a manual process with no fixed turnaround, so polling hourly or daily is reasonable, but polling more often is unlikely to return them sooner.
You can subscribe to receive a notification when the policy is bound. Policy documents will be available shortly afterward (See Webhooks).
This returns the documents for every policy on the client's account, not only the policy you just bound. For a client with bound renewals, expect to see the entire account history, including expiring policies as well as renewals.

Arguments for GetPolicyDocuments

Required Required to submit Optional

Pass these as variables.

Get Policy Documents arguments
Name Type Required Description
clientId ID! Required

Id of the client to make the request for

See Create Client for the client id.

Response fields for GetPolicyDocuments

Select only the fields you need in the selection set.

Get Policy Documents response fields
Name Type Description
client.policies.edges [PolicyEdge]

List of policy ids (node.id), and documents URLs (node.policyData)

Policy documents by category

policyDocuments(policyId: $policyId, documentCategory: $documentCategory)
Product
Smart Cyber
Method
POST
Endpoint
Sandbox: https://api-sandbox.corvusinsurance.com/q Production: https://crowbar.corvusinsurance.com/q
Authentication
Send the headers X-API-KEY, X-USER-EMAIL, X-USER-NAME with every request. See Authentication.
Returns one policy's documents in a single category, as an alternative to reading policyData for every policy on the client's account.
Document URLs expire after about five minutes (see FAQ). Request a new URL each time you download.

Arguments for policyDocuments

Required Required to submit Optional

Pass these as variables.

Policy documents by category arguments
Name Type Required Description
policyId ID! Required

Id of the policy. It must belong to your brokerage, otherwise not_found is returned

documentCategory DocumentCategory! Required

Which documents to return: one of POLICY_DOCS, INVOICES, UW_DOCS or COMMUNICATIONS

The documentCategory is one of:

  • POLICY_DOCS: policy documents, such as the binder and policy, plus the quote documents for the quote request
  • INVOICES: invoices
  • UW_DOCS: underwriting documents attached to the quote request
  • COMMUNICATIONS: always returns an empty list

Response fields for policyDocuments

Select only the fields you need in the selection set.

Policy documents by category response fields
Name Type Description
policyDocuments.id ID!

Id of the document

policyDocuments.name String!

File name of the document

policyDocuments.insertedAt DateTime!

When the document was added

policyDocuments.url String!

Download URL; it expires after about five minutes