Sign in

v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
API

Gerar endereço para autenticação

Gera um novo endereço para autenticação com o PSC escolhido. O link retornado deve ser exibido ao usuário que irá realizar a autenticação. Após autenticação e seleção do certificado pelo usuário, ele será redirecionado para o endereço enviado em 'redirectUri'. A este endereço também será adicionado o valore 'state' como query parameters. State corresponde ao estado enviado nesta requisição, sem alteração.

post/psc/link

Request body

pscNamestring

Nome do PSC para o qual será gerado o link de autenticação

redirectUristring

Endereço para o qual o usuário será redirecionado após autenticação no PSC. Ao realizar o redirecionamento, serão adicionados os valores 'state' como query parameters.

statestring

Estado para armazenar identificação do usuário. Ele será retornado sem alteração como um 'query parameter' após autenticação.

numberOfDocumentsnumber

Número de assinaturas que serão realizadas.

scope'single_signature' | 'multi_signature' | 'signature_session'

Preferência do escopo de assinatura que será utilizado pela requisição. single_signature: será permitido somente uma única assinatura, em uma única requisição. multi_signature: será permitido um lote de assinaturas, em uma única requisição. signature_session: será permitido uma sessão de assinaturas, permitindo realizar requisições de assinaturas por um determinado período.

lifetimenumber

Tempo de duração do token em segundos que será solicitado ao PSC. O tempo de duração do token pode ser modificado pelo PSC.

cpfstring

CPF para filtro do certificado escolhido. Não pode ser utilizado em conjunto com 'cnpj'.

cnpjstring

CNPJ para filtro do certificado escolhido. Não pode ser utilizado em conjunto com 'cpf'.

Example request

{
  "pscName": "Syn",
  "redirectUri": "https://example.com/callback",
  "state": "valid_state_string",
  "scope": "single_signature",
  "cpf": "123.456.789-09",
  "cnpj": "1a.2b3.4c5.6d7e-89"
}

Response

Link para autenticação com o PSC selecionado

tokenstring

Credencial gerada que deverá ser utilizada para os pedidos de assinatura utilizando o HUB Signer após autenticação e escolha do certificado

urlstring

Url para autenticação e seleção do certificado PSC

Example response

{
  "token": "63a489e1-e0c1-4273-be2b-696043104d43",
  "url": "https://psc.syngularid.com.br/v0/oauth/authorize"
}