Nodwch ddogfen fel wedi'i llofnodi

Marka dogfen fel wedi’i llofnodi pan fydd llofnod corfforol neu allanol wedi cael ei gael. Gallwch farcio’r ddogfen gyfan fel wedi’i chwblhau, neu farcio derbynnydd unigol fel wedi’i gwblhau os yw eraill yn dal i lofnodi. Gallwch lanlwytho PDF wedi’i lofnodi ar yr un pryd.

Gofynion Rhagofynol

• Eich ID dogfen (wedi’i godio base64) — os oes gennych UUID REST, rhagflaennwch ef gyda doc a chôdwch y canlyniad yn base64 (e.e. doc + <your-document-uuid> → base64). Gweler Deall IDs Gwe a IDs API am fanylion.

Dewis A: Marcio fel wedi’i lofnodi heb lanlwytho PDF

Galwch markAsComplete gyda isUploaded: false. Mae’r maes declarationText yn ofynnol — defnyddiwch ef i gofnodi’r rheswm pam mae’r ddogfen yn cael ei marcio fel wedi’i chwblhau (e.e. "Cadarnhad cegodol wedi’i gael", "Llofnod gwlyb wedi’i gyrraedd"). Gellir ei adael yn llinyn gwag, ond mae gwerth ystyrlon yn ddefnyddiol i bwrpasau archwilio.

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

Dewis B: Marcio fel wedi’i lofnodi gyda lanlwytho PDF

Cam 1: Cael URL lanlwytho wedi’i lofnodi’n flaenorol

Galwch y cwyn lanlwytho gyda uploadType: MARKASCOMPLETE i gael URL S3 byrhoedlog.

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

Ateb:

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

Cam 2: PUT y ffeil i S3

Lanlwythwch y PDF wedi’i lofnodi’n uniongyrchol i’r URL a ddychwelwyd gan ddefnyddio cais HTTP PUT gyda Content-Type: application/pdf. Mae’r URL yn fyrhoedlog — defnyddiwch ef ar unwaith. Gweler Lanlwytho ffeiliau am fwy o fanylion ar y cam PUT.

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

Cam 3: Marcio’r ddogfen fel wedi’i chwblhau

Galwch markAsComplete gyda isUploaded: true. Mae’r maes declarationText yn ymddwyn yr un fath â Dewis A.

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

Marcio derbynnydd unigol fel wedi’i lofnodi

Defnyddiwch markRecipientAsComplete pan fydd un parti wedi llofnodi yn allanol ond nid yw eraill wedi gwneud.

Os ydych am lanlwytho PDF wedi’i lofnodi ar gyfer y derbynnydd, cychwynnwch trwy gael URL wedi’i lofnodi’n flaenorol gan ddefnyddio uploadType: MARKRECIPIENTASCOMPLETE:

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

Yna PUTwch y ffeil i’r URL a ddychwelwyd — gweler Lanlwytho ffeiliau.

Meini Pwysig:

• suppressNextRecipientNotification — gosod i true i atal y derbynnydd nesaf yn nhrefn y llofnodi rhag cael ei hysbysu ar unwaith.
• auditlogText — dewisol. Gadewch yn wag os nad oes ei angen, ond mae gwerth ystyrlon yn ddefnyddiol i bwrpasau archwilio.

Yna galwch markRecipientAsComplete:

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

Archifo’r ddogfen (dewisol)

Unwaith y bydd wedi’i farcio fel wedi’i chwblhau, gallwch archifo’r ddogfen i’w symud o’r golwg o ddogfennau gweithredol.

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

Gosod restore: true i ddad-archifo.

Cysylltiedig

• Awdalhau
• markAsComplete
• markRecipientAsComplete
• cwyn lanlwytho