api-integration · Document

Documentos

Envío a firma, consulta por proceso, listados por fecha y reenvíos.

POST{URL}/document/sendToSign

Envía un PDF (base64) a firma con firmantes y coordenadas.

Body

{
  signatories: [
    {
      signatory: {
        rut: string,
        name: string,
        paternalLastName: string,
        maternalLastName: string,
        address: string,
        district: string,
        email: string,
        phone: string
      },
      signature: {
        xCoordinate: number,
        yCoordinate: number,
        pageNumber: number,
        type: number,
        alias: string
      }
    }
  ],
  document: base64,
  withProtocolization: boolean
}

Headers

{api-key}

Auth

Bearer

{token}

Response

Success

{
  success: true,
  data: {
    processId: uuid,
    createdDateAt: timestamp
  },
  error: null
}

Error

{
  success: false,
  data: null,
  error: <error description>
}

GET{URL}/document/getByProcessId/:processId

Detalle de proceso por UUID.

Headers

{api-key}

Auth

Bearer

{token}

Response

Success

{
  success: true,
  data: { /* proceso detail */ },
  error: null
}

Error

{
  success: false,
  data: null,
  error: <error description>
}

GET{URL}/document/getAll/:startDate/:endDate

Lista documentos del customer en un rango de fechas.

Fechas en formato aceptado por el pipe de la API (YYYY-MM-DD).

Headers

{api-key}

Auth

Bearer

{token}

Response

Success

{
  success: true,
  data: [ /* documentos */ ],
  error: null
}

Error

{
  success: false,
  data: null,
  error: <error description>
}

POST{URL}/document/resendToSign

Reenvía notificaciones de firma del proceso.

Body

{
  processId: uuid
}

Headers

{api-key}

Auth

Bearer

{token}

Response

Success

{
  success: true,
  data: { /* resultado */ },
  error: null
}

Error

{
  success: false,
  data: null,
  error: <error description>
}

POST{URL}/document/resendSignatoryToSign

Reenvía a un firmante específico.

Body

{
  processId: uuid,
  signatoryId: uuid
}

Headers

{api-key}

Auth

Bearer

{token}

Response

Success

{
  success: true,
  data: { /* resultado */ },
  error: null
}

Error

{
  success: false,
  data: null,
  error: <error description>
}

POST{URL}/document/changeSignatureType

Cambia tipo de firma del firmante (1 | 2 | 3).

Body

{
  processId: uuid,
  signatoryId: uuid,
  signatureType: 1 | 2 | 3
}

Headers

{api-key}

Auth

Bearer

{token}

Response

Success

{
  success: true,
  data: { /* resultado */ },
  error: null
}

Error

{
  success: false,
  data: null,
  error: <error description>
}