SigningSessions

Obter dados de bootstrap da sessão

Retorna os dados de bootstrap para o aplicativo de assinatura hospedado ou widget.

Autenticação via embedToken (clientSecret).

get/v1/signing-sessions/{sessionId}

Request

  • Base URL: https://api.signdocs.com.br
  • URL: https://api.signdocs.com.br/v1/signing-sessions/{sessionId}
  • Auth: HTTP bearer

Path parameters

sessionIdstring required

Identificador único da sessão de assinatura.

Response

Dados de bootstrap retornados com sucesso.

sessionIdstring required
transactionIdstring required
status'ACTIVE' | 'COMPLETED' | 'CANCELLED' | 'EXPIRED' | 'FAILED' required

Status da sessão de assinatura.

purpose'DOCUMENT_SIGNATURE' | 'ACTION_AUTHENTICATION' required

Finalidade da transação.

localestring required
returnUrlstring uri
cancelUrlstring uri
expiresAtstring date-time required

Example response

{
  "signer": {
    "name": "Maria Silva",
    "maskedEmail": "m***a@example.com",
    "maskedCpf": "***.***.***-01",
    "maskedPhone": "*******8888",
    "otpChannelSelectable": true,
    "availableOtpChannels": [
      "email",
      "whatsapp"
    ]
  },
  "action": {
    "type": "PIX_TRANSFER",
    "description": "Transferência PIX de R$ 5.000,00",
    "reference": "ref-abc-123"
  },
  "appearance": {
    "brandColor": "#1a5276",
    "logoUrl": "https://cdn.example.com/logo.png",
    "companyName": "Empresa Exemplo Ltda",
    "backgroundColor": "#ffffff",
    "textColor": "#333333",
    "buttonTextColor": "#ffffff",
    "borderRadius": "12px"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.