[PRIVYID] Callback Document

Status – Every Document

Completed v1.2
 No. Form:
PRIVY IDENTITAS DIGITAL 001/CDS/IT/PID/IV/2019
Jl. Kemang Raya No. 15 C, Lantai 4, Bangka, Mampang Prapatan, Revision: 01
Jakarta Selatan 12730
021 22715509 | assist@privy.id | www.privy.id Date: 06 May 2019
[PRIVYID] Callback Document Status -
Restricted Document
Every Document Completed v1.2
No : 1504201901
Date : 15-Apr-19

Document History

Date Document Version Description

April 15, 2019 1.0 Callback Event Document Status

April 29, 2019 1.1 Callback event document status Every document

completed

May 06, 2019 1.2 Update response (page 3,4)

 No. Form:
PRIVY IDENTITAS DIGITAL 001/CDS/IT/PID/IV/2019
Jl. Kemang Raya No. 15 C, Lantai 4, Bangka, Mampang Prapatan, Jakarta Revision: 01
Selatan 12730
021 22715509 | assist@privy.id | www.privy.id Date: 06 May 2019

[PRIVYID] Callback Document Status -

Restricted Document
Every Document Completed
No : 1504201901
Date : 15-Apr-19

Callback Event Document Status

Dokumentasi ini menunjukan response setelah event document completed. Untuk
mendapatkan callback, merchant harap menyediakan webhook yang mengizinkan external
service untuk diberi notifikasi ketika event tersebut terjadi.

Merchant dapat memilih untuk mendapat payload tanpa atau dengan URL download. URL
download memiliki waktu kedaluwarsa 15 menit. Jika sudah lebih dari 15 menit, merchant
tetap dapat mengunduh dokumen dengan hit API Check Status Document.

Status description
Status Registration Description
Completed Status dokumen yang menerangkan bahwa
dokumen telah tertandatangani.

Payload
Parameter’s name Type Example Description
eventName String document- Name of event
completed
data Object[] Array of signer data and
document status
docToken String 10e654e3adfc566b3 Document’s token
488a3bbca6bd32940
c7d288f3711b6f9db
4fe3e067e5a15

recipients Object[] Array of recipient data

and signatory status
privyId String MO2025 Recipient’s PrivyID
type String Signer Recipient’s role on the
document, example :
Signer, Reviewer.

signatoryStatus String Completed Recipient’s signatory

status on the document,
example : Completed
and In progress

2
 No. Form:
PRIVY IDENTITAS DIGITAL 001/CDS/IT/PID/IV/2019
Jl. Kemang Raya No. 15 C, Lantai 4, Bangka, Mampang Prapatan, Jakarta Revision: 01
Selatan 12730
021 22715509 | assist@privy.id | www.privy.id Date: 06 May 2019

[PRIVYID] Callback Document Status -

Restricted Document
Every Document Completed
No : 1504201901
Date : 15-Apr-19

documentStatus String Completed Document sign status,

example : Completed
and In Progress
download Object[] Array of url download
and url expiry time
url String http://api- url for download
sandbox.privy.id/ document
document/5IYUA4Wm
cf-a85d714c-6ef7-
4e3d-a16e-
57da9de14083
expiredAt String 2019-05- Url expiry time
03T07:08:33+00:00
message String Document has been Message of event
completed

Example Payload

1. Every document completed without URL download

Merchant akan mendapatkan notifikasi jika document telah completed tanpa
mendapatkan URL untuk download document.
{
"eventName": "document-completed",
"data": {
"docToken":
"532fcb9100c96fcfb53d1c9d61ed0036816e3238da2f2889023b9812ccc792b8",
"recipients": [
{
"privyId": "UAT001",
"type": "Reviewer",
"signatoryStatus": "Completed"
}
],
"documentStatus": "Completed"
},
"message": "Document has been completed"
}

3
 No. Form:
PRIVY IDENTITAS DIGITAL 001/CDS/IT/PID/IV/2019
Jl. Kemang Raya No. 15 C, Lantai 4, Bangka, Mampang Prapatan, Jakarta Revision: 01
Selatan 12730
021 22715509 | assist@privy.id | www.privy.id Date: 06 May 2019

[PRIVYID] Callback Document Status -

Restricted Document
Every Document Completed
No : 1504201901
Date : 15-Apr-19

2. Every document completed with URL download

Merchant akan mendapatkan notifikasi jika document telah completed dan
mendapatkan URL untuk download document.
{
"eventName": "document-completed",
"data": {
"docToken":
"4fb0f23ede0c68c8b1aa7fc56b1c0747170c3d1a8641ce8127ca37ca81c9232c",
"recipients": [
{
"privyId": "UAT001",
"type": "Reviewer",
"signatoryStatus": "Completed"
}
],
"documentStatus": "Completed",
"download": {
"url": "http://api-
sandbox.privy.id/document/osnPbRbbZ2-187b7248-4ee5-40fa-91ab-f1e76875b2aa",
"expiredAt": "2019-05-03T08:04:48+00:00"
}
},
"message": "Document has been completed"
}