- Document
IDalso known asdocument_id
Using
document_idparameters, you are able to check the status of the document such as how many signers have signed the document or whether document has been successfully notarized.
| Method | URI | Headers |
|---|---|---|
| GET | /client/document/{document_uuid} |
api_token |
e.g. F1D07090-F1AC-11EA-BC07-33809F0CA1BF
{info} It would show a different response from the OnlineNotary API. Its either
success,unauthenticatedorfail.
200{success} When
document_idis correctly submitted to our endpoint, all of the available details will be shown back in a success response.
{
"uuid": "F1D07090-F1AC-11EA-BC07-33809F0CA1BF",
"file": "flatten9f6a31d2fe02e2e9a471fcf1e4a46398.pdf",
"title": "POA.pdf",
"paid": 0,
"cancel": 0,
"created_at": {
"date": "2020-09-08 01:26:08.000000",
"timezone_type": 3,
"timezone": "America/Los_Angeles"
},
"updated_at": {
"date": "2020-09-08 01:26:08.000000",
"timezone_type": 3,
"timezone": "America/Los_Angeles"
},
"original_url": "https://s3.amazonaws.com/on-docs-ai8y2/2_c81e728d9d4c2f636f067f89cc14862c/9f6a31d2fe02e2e9a471fcf1e4a46398/POA.pdf",
"notarized_url": null,
"completed": false,
"conference": false,
"completed_on": null,
"signers": {
"notary_url": "https://app.onlinenotary.net/sign/u/F1DF26B0-F1AC-11EA-820B-9FCCA3EC9F4C",
"fullname": "John Doe",
"email": "[email protected]",
"turn": 1,
"tech_check": 0,
"signer_verified": 1,
"signature_picked": 1,
"id_scan": 1
}
}
{danger} Error response is shown if we are unable to find document or if document was not uploaded using your API key.
400{
"success": false,
"error": {
"code": 0,
"message": "Document not found."
}
}
{danger} Error response
api_tokenis not authenticated, Please contact our support team.
400{
"success": false,
"error": {
"code": 0,
"message": "Unauthenticated."
}
}
$client = new Client();
$api_key = 'api_key';
$url = 'https://production.onlinenotary.net/api/v1/client/document/A707C410-0EFD-11EB-8AF2-7500D54EC396';
$response = $client->request('GET', $url ,
['auth' => [
null,
$api_key
],
]);