Check document coverage
Compare the documents already filed with a category checklist.
/api/v1/gapshttps://api.webcite.coWhen to use it
This is an advisory checklist. present means a supplied record matched the checklist; it does not establish that the contents are complete or correct. Choose vc or ma taxonomy and, where appropriate, early or growth stage.
Request
1 credit.
Examples run on your server. Set WEBCITE_API_KEY first. Python examples use the requests package.
curl --fail-with-body -X POST 'https://api.webcite.co/api/v1/gaps' \
-H "x-api-key: $WEBCITE_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"category": "financial",
"docs": [],
"taxonomy": "vc",
"stage": "early"
}'Request body
categorystringrequiredThe category whose expected-documents checklist to compute.
docsobject[]requiredThe documents currently filed in that category.
Show docs fields
categorystringcoversstring[]filenamestringlabelstringstagestringStage to tailor the checklist to.
Values: "early""growth"
taxonomystringTaxonomy preset. Default "vc".
Values: "vc""ma"
Response
Returns items with name and present. A match can come from a filename, category, or covered document type.
200 response
See the response guidance above. A complete JSON schema is not published for this response.
Errors
For 400, check the request fields and source identifiers. For 401, check your API key. For 429, wait for the retry interval. See the errors guide before retrying a billable request.
401- Unauthorized - API key required
429- Rate limit exceeded