Documentation Powered by ReDoc

APIs de Contas e Confiabilidades (1.1.2)

Download OpenAPI specification:Download

APIs de Contas e Confiabilidades

Campos Retornados da API de Contas

Nome Tipo Conteúdo
id string CPF do cidadão
name string Nome do cidadão
email string Email do cidadão
emailVerified string Flag email validado
phoneNumber string Número do telefone celular. Exemplo: "91987479411"
phoneNumberVerified string Flag número do telefone celular validado
status string Estado
creationLocalDateTime string Data da criação. Exemplo: "2020-05-07T21:31:52.635"

Campos Retornados da API de Confiabilidades

Nome Tipo Conteúdo
confiabilidade* string Estrutura
dataCriacao string Data da criação. Exemplo: ""2020-08-17T10:44:53.179-0300""
dataAtualizacao string Data da criação. Exemplo: "2020-08-17T10:44:53.179-0300"

*Confiabilidade

Nome Tipo Conteúdo
id* string Estrutura
categoria string Data da criação. Exemplo: "bb_internet_banking"
titulo string Data da criação. Exemplo: "internet_banking"
descricao string Data da criação. Exemplo: "Validação através Autenticação no Internet Banking do Banco do Brasil"

Authentication

OAuth2

A autenticação é feita usando um token de acesso padrão JWT (JSON Web Token). Este token tem duração de 2 horas, recomendamos armazená-lo na aplicação cliente para uso nas Requisições ao serviço durante seu tempo de validade. Chamadas desnecessárias ao serviço de geração de tokens geram tráfego adicional na rede e podem degradar a performance da API, aumentando os tempos de resposta.

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://apigateway.conectagov.estaleiro.serpro.gov.br/oauth2/jwt-token
Scopes:

    Consulta Contas

    Consulta a conta a partir de um cpf

    Authorizations:
    OAuth2
    path Parameters
    cpf
    required
    string
    header Parameters
    x-cpf-usuario
    required
    string
    Default:

    CPF do usuário da requisição

    Responses

    200

    Retorna os dados do CPF consultado.

    401

    Informe o CPF do usuário do sistema.

    get/api-govbr-contas/v1/contas/{cpf}
    https://apigateway.conectagov.estaleiro.serpro.gov.br/api-govbr-contas/v1/contas/{cpf}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "id": "string",
    • "name": "string",
    • "email": "string",
    • "emailVerified": "string",
    • "phoneNumber": "string",
    • "phoneNumberVerified": "string",
    • "status": "string",
    • "creationLocalDateTime": "string"
    }

    Consulta Confiabilidades

    Verifica a confiabilidade de uma conta a partir de um cpf

    Authorizations:
    OAuth2
    path Parameters
    cpf
    required
    string
    header Parameters
    x-cpf-usuario
    required
    string
    Default:

    CPF do usuário da requisição

    Responses

    200

    Retorna os dados do CPF consultado.

    401

    Informe o CPF do usuário do sistema.

    get/api-govbr-confiabilidades/v1/confiabilidades/{cpf}
    https://apigateway.conectagov.estaleiro.serpro.gov.br/api-govbr-confiabilidades/v1/confiabilidades/{cpf}

    Response samples

    Content type
    application/json
    Copy
     Expand all Collapse all
    {
    • "confiabilidade":
      {
      },
    • "dataCriacao": "string",
    • "dataAtualizacao": "string"
    }