List review requests

List what Everee has asked for during review.

Use this endpoint to see what Everee needs from you during review. A request is open while resolvedAt is null. The same list is included in Retrieve onboarding status.

📘

Part of Review requests. For how this fits into onboarding, see the guide: Submitting for review: responding to requests.

Request types

typeWhat Everee needsHow to answer
DOCUMENT_NEEDEDA document. documentType says which: PROOF_OF_BUSINESS_ADDRESS, IRS_EIN_LETTER, IRS_FORM_944_LETTER, CERTIFICATE_OF_AUTHORITY or OTHER.Fulfill a request with a file
INFORMATION_NEEDEDAn answer to a question in message.Fulfill a request with text, or with a file
ADDITIONAL_PERSON_DETAILSAnother beneficial owner.Add a beneficial owner with this request's requestId.
IDENTITY_VERIFICATION_NEEDEDA person (personRef, subjectName) whose identity link needs to be reissued.Correct a person's contact details or resend the link. The request resolves when the link is reissued.
CONTRACT_CORRECTIONThe contract documents have to be signed again.The signer signs again in the hosted experience. The request resolves when they do.

Errors

StatusMeaning
401The API key is missing, malformed or expired.
404No company with this ID belongs to your partner account.
Path Params
integer
required

The company's ID, as returned when the company was created.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json