Ir para o conteúdo

Endpoints e Gateways

Gateway APISerpro

O Gateway de APISerpro foi criado como uma evolução do seu antecessor, para melhorar o desempenho e latência do serviço. A partir de novembro de 2020, os novos clientes devem utilizar as URLs abaixo, de acordo com o respectivo plano e endpoint desejado.

As chaves de acesso podem ser encontradas na área do cliente selecionando a opção de contrato. Basta escolher a opção correspondente ao contrato vigente, SEM escolher a opção que contém a informação "DEPRECATED":

Menu área cliente

Endereço de autenticação

https://gateway.apiserpro.serpro.gov.br/token

Endpoints de acesso ao serviço

Informações completas na Referência da API

Estes são apenas exemplos para a compreensão da URL do gateway e endpoint utilizados. Para informações completas dos endpoints disponíveis, veja a Referencia da API.

Plano Individual:
https://gateway.apiserpro.serpro.gov.br/datavalid/v2/status
https://gateway.apiserpro.serpro.gov.br/datavalid/v2/validate/pf
https://gateway.apiserpro.serpro.gov.br/datavalid/v2/validate/pf-digitais
https://gateway.apiserpro.serpro.gov.br/datavalid/v2/validate/pf-face
https://gateway.apiserpro.serpro.gov.br/datavalid/v2/validate/pf-imagem
https://gateway.apiserpro.serpro.gov.br/datavalid/v2/validate/pj
Plano Entidade de classe:
https://gateway.apiserpro.serpro.gov.br/datavalid-entidade/v2/status
https://gateway.apiserpro.serpro.gov.br/datavalid-entidade/v2/validate/pf
https://gateway.apiserpro.serpro.gov.br/datavalid-entidade/v2/validate/pf-digitais
https://gateway.apiserpro.serpro.gov.br/datavalid-entidade/v2/validate/pf-face
https://gateway.apiserpro.serpro.gov.br/datavalid-entidade/v2/validate/pf-imagem
https://gateway.apiserpro.serpro.gov.br/datavalid-entidade/v2/validate/pj

Gateway antigo (DESCONTINUADO)

Para clientes que contrataram até meados de outubro de 2020 os endereços de produção são os abaixo, referentes ao Gateway antigo.

Gateway Descontinuado

Este Gateway (apigateway.serpro.gov.br) será descontinuado (Deprecated) em breve, portanto recomendamos a utilização do Gateway APISerpro.

Para o guia rápido de como autenticar e consumir a API utilizando as URLs antigas (Gateway antigo), acesse o guia rápido contendo os endereços antigos.

Endereço de autenticação

https://apigateway.serpro.gov.br/token

Endpoints de acesso ao serviço

Informações completas na Referência da API

Estes são apenas exemplos para a compreensão da URL do gateway e endpoint utilizados. Para informações completas dos endpoints disponíveis, veja a Referencia da API.

Plano Individual:
https://apigateway.serpro.gov.br/datavalid/v2/status
https://apigateway.serpro.gov.br/datavalid/v2/validate/pf
https://apigateway.serpro.gov.br/datavalid/v2/validate/pf-digitais
https://apigateway.serpro.gov.br/datavalid/v2/validate/pf-face
https://apigateway.serpro.gov.br/datavalid/v2/validate/pf-imagem
https://apigateway.serpro.gov.br/datavalid/v2/validate/pj
Plano Entidade de classe:
https://apigateway.serpro.gov.br/datavalid-entidade/v2/status
https://apigateway.serpro.gov.br/datavalid-entidade/v2/validate/pf
https://apigateway.serpro.gov.br/datavalid-entidade/v2/validate/pf-digitais
https://apigateway.serpro.gov.br/datavalid-entidade/v2/validate/pf-face
https://apigateway.serpro.gov.br/datavalid-entidade/v2/validate/pf-imagem
https://apigateway.serpro.gov.br/datavalid-entidade/v2/validate/pj