Marcáil doiciméad mar sínte

Cuir marc ar dhoiciméid mar sínithe nuair a fuarthas síniú fisiciúil nó as-band. Is féidir leat an doiciméad iomlán a Marcáil mar chríochnaithe, nó duine aonair a marcáil mar chríochnaithe má tá daoine eile fós ag síniú. Is féidir leat PDF sínithe a uaslódáil ag an am céanna.

Réamhchritéir

• Do ID doiciméid (códaithe i mbase64) — má tá UUID REST agat cuir tosaigh doc leis agus códáil an toradh i mbase64 (m.sh. doc + <your-document-uuid> → base64). Féach Tuig IDanna Gréasáin agus IDanna API le haghaidh sonraí.

Rogha A: Marcáil mar sínithe gan uaslódáil PDF

Glaoigh ar markAsComplete le isUploaded: false. Tá an réimse declarationText riachtanach — bain úsáid as chun an chúis a thaifeadadh cén fáth go bhfuil an doiciméad marcáilte mar chríochnaithe (m.sh. "Fíorú béil faighte", "Síniú fliuch faighte"). Is féidir é a fhágáil mar shlánscéal bán, ach tá luach úsáideach do chuspóirí iniúchta.

mutation MarkAsComplete {
  markAsComplete(input: {
    documentId: "<document-id>"
    declarationText: "Verbal confirmation received"
    isUploaded: false
  })
}

Rogha B: Marcáil mar sínithe le húsáid PDF

Céim 1: Faigh URL uaslódála réamhshínithe

Glaoigh ar an upload query le uploadType: MARKASCOMPLETE chun URL S3 gearrthéarmach a fháil.

query GetUploadUrl {
  upload(
    id: "<document-id>"
    uploadType: MARKASCOMPLETE
    extension: "pdf"
  ) {
    url
  }
}

Freagra:

{
  "data": {
    "upload": {
      "url": "https://lon-files-clearing.s3-accelerate.amazonaws.com/upload/..."
    }
  }
}

Céim 2: Cuir an comhad ar S3 le PUT

Uaslódáil an PDF sínithe go díreach chuig an URL a tugadh ar ais ag úsáid iarratas HTTP PUT le Content-Type: application/pdf. Tá an URL gearrthéarmach — bain úsáid as láithreach. Féach Uaslódáil comhaid le haghaidh níos mó sonraí faoin gcéim PUT.

curl -X PUT \
  -H "Content-Type: application/pdf" \
  --data-binary @signed-copy.pdf \
  "<url from previous step>"

Céim 3: Marcáil an doiciméid mar chríochnaithe

Glaoigh ar markAsComplete le isUploaded: true. Tá iompar an réimse declarationText mar an gcéanna le Rogha A.

mutation MarkAsComplete {
  markAsComplete(input: {
    documentId: "<document-id>"
    declarationText: "Signed copy received by post"
    isUploaded: true
  })
}

Marcáil faighteoir singil mar sínithe

Úsáid markRecipientAsComplete nuair a tá páirtí amháin sínithe as-band ach níor síníodh daoine eile fós.

Má tá tú ag iarraidh PDF sínithe a uaslódáil don fhaighteoir, faigh URL réamhshínithe ar dtús ag úsáid uploadType: MARKRECIPIENTASCOMPLETE:

query GetUploadUrl {
  upload(
    id: "<recipient-id>"
    uploadType: MARKRECIPIENTASCOMPLETE
    extension: "pdf"
  ) {
    url
  }
}

Ansin cuir an comhad ar an URL a tugadh ar ais le PUT — féach Uaslódáil comhaid.

Réimsí Tábhachtacha:

• suppressNextRecipientNotification — socraigh go true chun cosc a chur ar an chéad fhaighteoir eile sa seicheamh sínithe a fháil foláireamh láithreach.
• auditlogText — roghnach. Fág folamh mura bhfuil gá leis, ach tá luach chuí úsáideach do chuspóirí iniúchta.

Ansin glaoigh markRecipientAsComplete:

mutation MarkRecipientAsComplete {
  markRecipientAsComplete(input: {
    recipientId: "<recipient-id>"
    documentOptions: NONE
    suppressNextRecipientNotification: false
    auditlogText: "Signed copy received by post"
  }) {
    id
    uploadId
  }
}

Cartlannigh an doiciméad (roghnach)

Nuair a bheidh marcáilte mar chríochnaithe, is féidir leat an doiciméad a chartlannú chun é a bhaint as an amharc doiciméid gníomhacha.

mutation ArchiveDocument {
  archiveDocument(input: {
    documentId: "<document-id>"
    restore: false
  })
}

Socraigh restore: true chun neamhchartlannú a dhéanamh.

Gaolmhar

• Údarú
• markAsComplete
• markRecipientAsComplete
• upload query