Docs Referência da API

Visão Geral

Referência

...

Nesta página

Referência da API

Nova Solicitação

post http://api.icp-signature.br.iugu.com/payloads

Nova Solicitação

Autorizações
oauth2Auth Autenticação por Bearer
Flow type: clientCredentials
Token URL: https://identity.iugu.com/token
Scopes:
  • audience - Iugu.Platform.0xS24hQtnN5ntHXG9XrHyK

Schema

Tipo de conteúdo: application/json
fiscal_code

Obrigatório

String

Ex: 15111975000164
body

Obrigatório

String

Ex: {"name": "Patrick Negri"}
Exemplo 
1
2
3
4

{
  "fiscal_code": "15111975000164",
  "body": "{\"name\": \"Patrick Negri\"}"
}

Parâmetros no Cabeçalho

  • workspace_id
    String

    Ex: 1hC4SaHg52IMbtwb35Xb7a

Respostas
200
Detalhes de uma Solicitação
id
String

Código da Solicitação

Ex: ce20eacd-8f76-4537-a7bf-bbc221318967
user_id
String

Código do Usuário da Solicitação

Ex: ed04a208-d6d2-48ef-8087-c737d1ac8d67
body
String

Conteúdo a ser assinado

Ex: {"name": "Patrick Negri"}
fiscal_code
String

CPF ou CNPJ

Ex: 15111975000164
status
String

Situação da Solicitação

Ex: pending
created_at
String

Data de criação. Respeita RFC 3339.

Ex: 2024-02-05T19:16:46.182Z
updated_at
String

Data de atualização. Respeita RFC 3339.

Ex: 2024-02-05T19:16:46.182Z
signature_url
String

Link para Assinatura

Ex: https://sign.icp-signature.br.iugu.com/validate/6GxSg5J1ZoHWsFCF6UWzIt
422
Unprocessable Content
errors
Object

Lista de Erros no Campos
$field_name
Array

Lista de Erros do Campo
error
String

Detalhes de uma Solicitação

get http://api.icp-signature.br.iugu.com/payloads/{id}

Retorna Validação

Autorizações
oauth2Auth Autenticação por Bearer
Flow type: clientCredentials
Token URL: https://identity.iugu.com/token
Scopes:
  • audience - Iugu.Platform.0xS24hQtnN5ntHXG9XrHyK

Parâmetros de Path

  • id

    Obrigatório

    String

    Código da Validação

    Ex: c4cbcce8-59b1-4021-a167-de5fd36d33cb

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 1hC4SaHg52IMbtwb35Xb7a

Respostas
200
OK
id
String

Código da Solicitação

Ex: ce20eacd-8f76-4537-a7bf-bbc221318967
user_id
String

Código do Usuário da Solicitação

Ex: ed04a208-d6d2-48ef-8087-c737d1ac8d67
body
String

Conteúdo a ser assinado

Ex: {"name": "Patrick Negri"}
fiscal_code
String

CPF ou CNPJ

Ex: 15111975000164
status
String

Situação da Solicitação

Ex: pending
created_at
String

Data de criação. Respeita RFC 3339.

Ex: 2024-02-05T19:16:46.182Z
updated_at
String

Data de atualização. Respeita RFC 3339.

Ex: 2024-02-05T19:16:46.182Z
signature_url
String

Link para Assinatura

Ex: https://sign.icp-signature.br.iugu.com/validate/6GxSg5J1ZoHWsFCF6UWzIt
404
Not Found

Voltar

Sumário de Implementação

Avançar

Explorer