Flow Register Business Card

Subject	SubjectType	SubjectIdentifier
digitalid	enrollment	business-card

API Action Digital ID - Business Card

API UPLOAD PHOTO

API endpoint for upload photo using Base64 format.

Payload Data

Name	Date Type	Description
Photo	String	Photo Base64_string_photo
PhotoType	String	Type Photo

Example Request

{
   "Subject":"digitalid",
   "SubjectType":"enrollment",
   "SubjectIdentifier":"business-card",
   "Action":"upload-photo",
   "ResourceType":"data",
   "Resource":"nik",
   "ResourceId":"321231990",
   "Data":{
      "Photo":"base64_string_photo",
      "PhotoType":"KTP"
   }
}

API REGISTER Business Card

API to perform the registration digitization of BusinessName Card document, no validation is done to third parties. The API is asynchronous.

Payload Data

Name	Date Type	Description
Name	String	Bussiness Card Name
Company	String	Bussiness Card Company
Department	String	Bussiness Card Department
Image	String	Bussiness Card Image
Color	String	Bussiness Card Color
PhoneNo	String	Bussiness Card Phone No
OfficePhoneNo	String	Bussiness Card Office Phone No
Email	String	Bussiness Card Email Phone No
Address	String	Bussiness Card Office Address Phone No
Website	String	Bussiness Card Website Phone No
CardType	String	Document Card Type

Example Request

{
   "Subject":"digitalid",
   "SubjectType":"enrollment",
   "SubjectIdentifier":"business-card",
   "Action":"register",
   "ResourceType":"data",
   "Resource":"nik",
   "ResourceId":"321231990",
   "Data":{
      "Name":"John",
      "Company":"PT Qoin",
      "Department":"Staff",
      "Image":"",
      "Color":"1",
      "PhoneNo":"08126958839",
      "OfficePhoneNo":"021992093",
      "Email":"[email protected]",
      "Address":"Jalan Pulomas Barat V A",
      "Website":"https://www.office.id/",
      "CardType":"4"
   }
}

API GET REGISTER DOCUMENT

An API used to retrieve data from a document registration result through an Asynchronous Document Register API.

Payload Data

Name	Date Type	Description
Key	String	Key

Example Request

{
   "Subject":"digitalid",
   "SubjectType":"enrollment",
   "SubjectIdentifier":"business-card",
   "Action":"get-register-async",
   "ResourceType":"data",
   "Resource":"nik",
   "ResourceId":"321231990",
   "Data":{
      "Key":"1644564383"
   }
}

API GET LIST DOCUMENT BY USER

API to get document data based on UserId.

Example Request

{
   "Subject":"digitalid",
   "SubjectType":"enrollment",
   "SubjectIdentifier":"business-card",
   "Action":"get-document-list",
   "ResourceType":"data",
   "Resource":"nik",
   "ResourceId":"321231990",
   "Data":{}
}

API REQUEST BUSSINESS CARD

API to request another user's business card document to enter the list of documents that the requested user owns.

Payload Data

Name	Date Type	Description
DocId	String	Document ID Number

Example Request

{
   "Subject":"digitalid",
   "SubjectType":"enrollment",
   "SubjectIdentifier":"business-card",
   "Action":"request-bc",
   "ResourceType":"data",
   "Resource":"nik",
   "ResourceId":"321231990",
   "Data":{
      "DocId":"157"
   }
}

API APPROVAL BUSINESS CARD

API to approval request of a business card document carried out by another user. This API defines what data is allowed to be provided to a user who requests a business-card document.

Payload Data

Name	Date Type	Description
DocId	String	Document ID Number
Status	String	Status
Reason	String	Notes approval
AvailableField	String	Field data is a must to fill

Example Request

{
   "Subject":"digitalid",
   "SubjectType":"enrollment",
   "SubjectIdentifier":"business-card",
   "Action":"approval-bc",
   "ResourceType":"data",
   "Resource":"nik",
   "ResourceId":"321231990",
   "Data":{
      "DocId":"157",
      "Status":"approve",
      "Reason":"Tidak kenal",
      "AvailableField":"name,company,image,position,phoneno,officephoneno,officeemail,officeaddress,website"
   }
}

API DELETE BUSINESS CARD

API to delete document data based on DocId.

Payload Data

Name	Date Type	Description
DocId	String	Document ID Number

Example Request

{
   "Subject":"digitalid",
   "SubjectType":"enrollment",
   "SubjectIdentifier":"business-card",
   "Action":"delete-bc",
   "ResourceType":"data",
   "Resource":"nik",
   "ResourceId":"321231990",
   "Data":{
      "DocId":"157"
   }
}

API UPDATE BUSSINESS CARD

API to update business card user.

Payload Data

Name	Date Type	Description
Name	String	Bussiness Card Name
Company	String	Bussiness Card Company
Department	String	Bussiness Card Department
Image	String	Bussiness Card Image
Color	String	Bussiness Card Color
PhoneNo	String	Bussiness Card Phone No
OfficePhoneNo	String	Bussiness Card Office Phone No
Email	String	Bussiness Card Email Phone No
Address	String	Bussiness Card Office Address Phone No
Website	String	Bussiness Card Website Phone No
CardType	String	Document Card Type

Example Request

{
   "Subject":"digitalid",
   "SubjectType":"enrollment",
   "SubjectIdentifier":"business-card",
   "Action":"update-bc",
   "ResourceType":"data",
   "Resource":"nik",
   "ResourceId":"321231990",
   "Data":{
      "DocId":"516",
      "DocName":"John",
      "DocCompany":"PT Qoin",
      "DocDepartment":"Staff",
      "DocPictPrimary":"",//base64 image
      "DocColor":"1",
      "PhoneNo":"08126958839",
      "OfficePhoneNo":"021992093",
      "OfficeEmail":"[email protected]",
      "OfficeAddress":"Jalan Pulomas Barat V A",
      "Website":"https://www.office.id/"
   }
}