API Reference

Approve document of file.

patch
https://app.credentially.io/gateway/api/documents/approve

Approve specific document and file.

Rate Limit: approve-document (5 req / 1s)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for approving/declining a file.
'documentPublicId', 'fileId' and 'organisationId' are mandatory; 'note' is mandatory only for rejecting.

string
int64
int64
string
string

The public Id from the profile that will be marked as the verifier on approval.
This field is required when the session token is from a public-api (server-to-server).
In other cases this parameter is not required and even ignored to use the id from the user in session.

Headers
string
enum
Defaults to 2.0.0
Allowed:
Responses
200

Document approved successfully

400

Bad request, e.g. 'VerifierPublicId not found'

404

Document or file not found

500

Internal server error

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 3 months ago

Did this page help you?