valor fixo “S256”

Valor correspondente ao método utilizado na chave de prova (code_verifier) para derivar o desafio (code_challenge).

psc

[opcional]

lifetime

[opcional]

login_hint

[opcional]

redirect_uri

[opcional]

state

[opcional]

scope

[opcional]

var crypto = require('crypto')
function base64URLEncode(str) {
    return str.toString('base64')
        .replace(/\+/g, '-')
        .replace(/\//g, '_')
        .replace(/=/g, '');
}
var verifier = base64URLEncode(crypto.randomBytes(32));
console.log("verifier: " + verifier);
function sha256(buffer) {
    return crypto.createHash('sha256').update(buffer).digest();
}
var challenge = base64URLEncode(sha256(verifier));
console.log("challenge: " + challenge);

249 (TOKEN_VALIDITY_INVALID)

250 (INVALID_ACCESS_TOKEN)

209 (BAD_AUTHENTICATION)

205

(REQUEST_BAD_DATA)

Retornado quando:

– Não há certificado no slot do PSC;

– O Alias fornecido não condiz com nenhum certificado no slot do PSC.

224

(ERROR_DURING_AUTHENTICATION)

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

Autorização do tipo “Bearer” sendo o token o valor retornado no atributo “access_token” presente na resposta da chamada 4. client_token, 8. otp_authorize, 10. pwd_authorize ou 12. token.

application/json

O conteúdo do body da requisição deve ser em formato JSON.

{
  "client_id": "{CLIENT_ID}",
  "client_secret": "{CLIENT_SECRET}",
  "name": "{NAME}",
  "comments": "{COMMENTS}",
  "redirect_uris": [
  "{REDIRECT_URIS}
],
  "email": "{EMAIL}"
}

application/x-www-form-urlencoded

O body da requisição quando enviado possui o formato de uma string query separada por &.

{  
  "client_id": "{CLIENT_ID}",
  "client_secret": "{CLIENT_SECRET}",
  "grant_type": "{GRANT_TYPE}",
  "lifetime": "{LIFETIME}"
}

Refazer a requisição após revisá-la garantindo que seu formato está de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

Retornado quando:

– Não há uma transação associada ao id de transação passado;

– A transação não pertence à empresa que fez a solicitação;

Retornado quando:

– Não há uma assinatura válida para realizar o download;

– O padrão de assinatura utilizado na transação não aceita o download;

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

multipart/form-data

Permite o envio de grandes quantidades de dados binários, útil para o envio de lotes grandes de arquivos

{

O conteúdo do arquivo será enviado como um campo “file” de um formulário.

}

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

{
  "client_id": "{CLIENT_ID}",
  "client_secret": "{CLIENT_SECRET}",
  "user_cpf_cnpj": "{CPF}",
  "val_cpf_cnpj": "{USERNAME}"
}

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

application/json

O conteúdo do body da requisição deve ser em formato JSON.

{
  "client_id": "{CLIENT_ID}",
  "client_secret": "{CLIENT_SECRET}",
  "username": "{USERNAME}",
  "otp": "{OTP}",
  "scope": "{SCOPE}",
  "lifetime": "{LIFETIME}"
}

Retornado quando:

– As credenciais passadas estão erradas;

– Não há OTP para o usuário;

– O OTP passado é inválido.

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

application/json

O conteúdo do body da requisição deve ser em formato JSON.

{
  "client_id": "{CLIENT_ID}",
  "client_secret": "{CLIENT_SECRET}",
  "username": "{USERNAME}",
  "password": "{PASSWORD}",
  "scope": "{SCOPE}",
  "lifetime":"{LIFETIME}",
  "psc": "{PSC}"
}

psc

[opcional]

Retornado quando:

– O PSC que se deseja utilizar está desabilitado;

– O padrão de assinatura utilizado na transação não aceita o download;

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

Autorização do tipo “Bearer” sendo o token o valor retornado no atributo “access_token” presente na resposta da chamada 8. otp_authorize, 10. pwd_authorize ou 12. token.

application/json

O conteúdo do body da requisição deve ser em formato JSON.

{
  "signature_standard": "SIGNATURE_STANDARD",
  "signature_policy": "SIGNATURE_POLICY",
  "pki_name": "{PKI_NAME}",
  "detached": {DETACHED},
  "hashes": [
    {
      "id": "{ID}",
      "alias": "{ALIAS}",
      "hash": "{DOCUMENTO_HASH}"
    }
  ]
}

certificate_alias

[opcional]

Padrão de assinatura a ser utilizado nessa requisição. Os valores possíveis são: CADES, PADES, PADES_ICP_BR, XADES, XMLDSIG_ENVELOPED e XMLDSIG_ENVELOPING. Se não informado o valor a ser considerado é “CADES”.

Obs: No caso do signature_standard=”PADES” aplica-se automaticamente uma política equivalente à AD_RB só que nos padrões da ETSI

visible_signature_font_size

[depreciado]

visible_signature_height

[depreciado]

visible_signature_page

[depreciado]

visible_signature_pos_x

[depreciado]

visible_signature_pos_y

[depreciado]

visible_signature_width

[depreciado]

visible_signature_zoom

[depreciado]

visible_text

[depreciado]

Posição no eixo x à partir da margem esquerda.

Padrão: 0

Posição no eixo y à partir da margem de baixo.

Padrão: 0

Altura do campo de assinatura.

Padrão: 100

Aumenta ou diminui o tamanho da imagem da assinatura.

Padrão 1.0

Página em que a assinatura visual será inserida.

Padrão: 1

Posição da assinatura na página.

Valores possíveis: TOP_LEFT, TOP_CENTER

TOP_RIGHT, CENTER_LEFT, MIDDLE, CENTER_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT.

Padrão: TOP_LEFT

Alinhamento do texto da assinatura.

Valores possíveis: LEFT, RIGHT, CENTER.

Padrão: LEFT

Fonte que será utilizada no texto da assinatura.

Valores possíveis: HELVETICA, TIMES_ROMAN, COURIER.

Padrão: HELVETICA

Tamanho da fonte utilizada no texto da assinatura.

Padrão: 10

Padding do texto da assinatura.

Padrão: 0

Ângulo de rotação da assinatura. Valores possíveis: NONE, ROTATION_90 , ROTATION_180 , ROTATION_270

Padrão: NONE

Largura do campo de assinatura.

Padrão: 200

249 (TOKEN_VALIDITY_INVALID)

250 (INVALID_ACCESS_TOKEN)

209 (BAD_AUTHENTICATION)

807 (INVALID_CREDENTIALS)

Retornado quando o tipo de documento enviado não condiz com o padrão de assinatura solicitado

ex: documento do tipo XML enviado para uma assinatura PAdES que exige PDF.

Refazer a requisição utilizando um certificado válido para a política solicitada.

obs: Políticas ICP-Br apenas aceitam certificados ICP-Br

224

(ERROR_DURING_AUTHENTICATION)

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

{
  "client_secret": "{CLIENT_SECRET}",
  "client_id": "{CLIENT_ID}",
  "code": "{CODE}",
  "code_verifier": "{CODE_VERIFIER}",
  "grant_type": "{GRANT_TYPE}",
  "manager_id": "{MANAGER_ID}",
  "manager_secret": "{MANAGER_SECRET}",
  "psc": "{PSC}"
}

Retornado quando:

– O PSC informado não é válido;

– O PSC informado está desabilitado.

Refazer a requisição preenchendo corretamente o parâmetro code ou manager_secret.

No caso de não possuir uma URL de callback cadastrada, entrar em contato com o suporte do Certillion.

Retornado quando:

– O parâmetro code está errado;

– O parâmetro manager_id é inválido;

– A empresa não possuir uma URL de callback previamente cadastrada;

Refazer a requisição preenchendo corretamente o parâmetro code ou manager_secret.

No caso de não possuir uma URL de callback cadastrada, entrar em contato com o suporte do Certillion.

Retornado quando:

– O parâmetro manager_id, code ou code_verifier está vazio;

– O PSC não possui um certificado válido para utilizar em uma assinatura;

Refazer a requisição preenchendo o parâmetro faltante.

No caso do PSC não possuir um certificado válido, será necessário entrar em contato com o PSC para obter um novo certificado.

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

var crypto = require('crypto')
function base64URLEncode(str) {
   return str.toString('base64')
        .replace(/\+/g, '-')
        .replace(/\//g, '_')
        .replace(/=/g, '');
}
var verifier = base64URLEncode(crypto.randomBytes(32));
console.log("verifier: " + verifier);
function sha256(buffer) {
   return crypto.createHash('sha256').update(buffer).digest();
}
var challenge = base64URLEncode(sha256(verifier));
console.log("challenge: " + challenge);

Autorização do tipo “Bearer” sendo o token o valor retornado no atributo “access_token” presente na resposta da chamada 4. client_token, 8. otp_authorize, 10. pwd_authorize ou 12. token.

application/json

O conteúdo do body da requisição deve ser em formato JSON.

{
  "user_id": "{USER_ID}",
  "user_secret": "{USER_SECRET}",
  "lifetime": "{LIFETIME}" ,
  "scope": "{SCOPE}",
  "operation": "{OPERATION}",
  "psc": "{PSC}"
}

250 (INVALID_ACCESS_TOKEN)

209 (BAD_AUTHENTICATION)

205

(REQUEST_BAD_DATA)

224

(ERROR_DURING_AUTHENTICATION)

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

application/json

O conteúdo do body da requisição deve ser em formato JSON.

{
  "client_id": "{CLIENT_ID}",
  "client_secret": "{CLIENT_SECRET}",
  "user_cpf_cnpj": "{CPF}",
  "val_cpf_cnpj": "{USERNAME}",
  "psc": "{PSC}"
}

Refazer a requisição após revisá-la garantindo que seu formato está de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.

Autorização do tipo “Bearer” sendo o token o valor retornado no atributo “access_token” presente na resposta da chamada 4. client_token, 8. otp_authorize, 10. pwd_authorize ou 12. token.

application/json

O conteúdo do body da requisição deve ser em formato JSON.

{
  "signature": "{SIGNATURE}",
  "content": "{CONTENT}",
  "document_hash": "{DOCUMENTO_HASH}",
  "pki_name": "{PKI_NAME}"
}

250 (INVALID_ACCESS_TOKEN)

209 (BAD_AUTHENTICATION)

205

(REQUEST_BAD_DATA)

Retornado quando:

– A cadeia do certificado esta incompleta;

– A cadeia do certificado é inválida;

– Há um erro criptográfico na assinatura;

– Há um erro na codificação da assinatura;

– O algoritmo utilizado para realizar a assinatura não é suportado pelo Certillion;

– O formato do arquivo não é suportado;

– Falha na verificação da assinatura;

– Falha na verificação da política da assinatura;

205

(REQUEST_BAD_DATA)

Refazer a requisição após revisá-la garantindo que esteja de acordo com o esperado pelo método.

Caso o erro persista, entrar em contato com o suporte do Certillion.