Reviews
Reviews are risk assessments generated for companies and private persons. This guide covers creating reviews, retrieving review details, and listing reviews across your portfolio.
Create a company review
Use reviewCompanyCreate to generate a review for a company. The review calculates risk based on your team's configured risk settings:
mutation CreateCompanyReview {
reviewCompanyCreate(where: { id: "<company_id>" }) {
success
risk
id
context {
explanations
entity {
... on Company {
id
name
}
}
}
}
}The response includes:
risk— the calculated risk class (for example,LOW,MEDIUM,HIGH)id— the review ID, present only when the review is automatically completed based on your risk class settingscontext— risk explanations and the entities involved
Create a private person review
Use reviewPrivatePersonCreate for individuals:
mutation CreatePersonReview {
reviewPrivatePersonCreate(where: { id: "<person_id>" }) {
success
risk
id
context {
explanations
entity {
... on PrivatePerson {
id
name
}
}
}
}
}Retrieve a review
You can fetch a specific review by its ID for both companies and private persons.
Company review
Use the review query to fetch a specific company review:
query GetCompanyReview {
review(where: { id: "<review_id>" }) {
id
createdAt
calculatedRiskLevel
userAssessedRiskLevel
selfAssessment
validUntilDate
entityStatus
pdf
}
}The pdf field contains the review as a base64-encoded PDF.
The PDF is generated asynchronously — if it hasn't been
created yet, this field is null. Retry after a short delay
if needed.
Private person review
Use privatePersonReview for individual reviews:
query GetPersonReview {
privatePersonReview(where: { id: "<review_id>" }) {
id
createdAt
privatePersonId
userAssessedRiskLevel
validUntilDate
pdf
}
}List reviews by date range
Both company and private person reviews support pagination
with pageSize (max 100) and offset. Increment the
offset by pageSize to fetch the next page.
Company reviews
Use the reviews query to list all company reviews completed within a date range:
query ListCompanyReviews {
reviews(
from: "2025-01-01T00:00:00Z"
to: "2025-12-31T23:59:59Z"
pageSize: 50
offset: 0
) {
id
createdAt
companyId
calculatedRiskLevel
userAssessedRiskLevel
validUntilDate
entityStatus
}
}Private person reviews
Use privatePersonReviews for individuals:
query ListPersonReviews {
privatePersonReviews(
from: "2025-01-01T00:00:00Z"
to: "2025-12-31T23:59:59Z"
pageSize: 50
offset: 0
) {
id
createdAt
privatePersonId
userAssessedRiskLevel
validUntilDate
}
}Access reviews from an entity
Reviews are also available directly on the entity. Use the privatePerson query or company query to see all reviews for a specific entity:
query GetCompanyWithReviews {
company(where: { id: "<company_id>" }) {
name
reviews {
id
createdAt
calculatedRiskLevel
userAssessedRiskLevel
validUntilDate
}
nextScheduledReviewDate
}
}