Detail

Overview

You can get document detail by using this API.
Document detail is including document details, signer list, document owner information, attached file list.
You should be owner of document and document was uploaded through API.

API detail

Request

• URL: /document/get/{{GUID}}
• Method: GET

Response

Success

• Status code: 200
• Body:

{
  "data": {
    "GUID": "0fe75c65-70cc-4517-ac7f-ebba85bfa63e",
    "doc_id": "50361222",
    "document": "/document/0fe75c65-70cc-4517-ac7f-ebba85bfa63e.pdf",
    "origin_document": "document/0fe75c65-70cc-4517-ac7f-ebba85bfa63e.pdf",
    "file_name": "test from postman.pdf",
    "subject": null,
    "description": "test from postman",
    "created_at": "2021-10-19T16:05:44.158662Z",
    "updated_at": "2021-10-19T16:05:44.158662Z",
    "sign_status": 0,
    "comment": null,
    "signature_key": null,
    "base64": "JVBERioxLjUNCiW1tbWiDQoxIDAgb2JDo9PC....",
    "callback_url": null,
    "callback_key": null,
    "delete_after_callback": false,
    "is_skip_notification": false,
    "owner": {
      "email": "document.owner@legale.io",
      "role": 2,
      "nickname": null,
      "firstname": "John",
      "lastname1": "De",
      "lastname2": "Doe",
      "avatar": null,
      "gender": 1,
      "id_type": 1,
      "id_number": "11.222.333-k",
      "user_video": "/user_video/163199848893.mp4",
    },
    "sign_list": [
      {
        "id": 1,
        "sign_method": "bit4id",
        "signer_info": {
          "id": 1,
          "email": "signer.email@legale.io",
          "phone": null,
          "firstname": "Signer",
          "lastname1": "Name",
          "lastname2": "Example",
        }
      }
    ],
    "attached_file_list": [],
  },
  "code": null,
  "message": "", 
}

• sign_status

Value	Type	Description
0	int	Not signed
1	int	Signed
2	int	Rejected

Error

• Status code: 400
• Body:

{
  "code": "DOCUMENT_NOT_FOUND",
  "message": "Document not found",
}

Error code	Type	Description
DOCUMENT_NOT_FOUND	str	GUID you passed to the url is invalid, couldn't find document by that.
NOT_OWNER	str	You are not owner of that document, you have no permission to see it.
NOT_API_DOCUMENT	str	Document was found, and you are the owner, but document was not from API, if you wanna see that document detail, you should open legale platform.