Captura de documentos

Bem-vindo à documentação dos SDKs Captura de Documentos da ClearSale

Este manual é para desenvolvedores que desejam fazer a implementação da ferramenta de captura de documentos via SDKs para sistemas em iOS e Android.

Através desta solução, o usuário consegue capturar a frente e verso de documentos de identidade de forma ágil e eficiente, com instruções simples e objetivas, além de diversas orientações visuais e um fluxo pensado em uma excelente usabilidade.

A ClearSale respeita as políticas de privacidade para a formação de uma base de dados por meio de coleta de fotos, que serão armazenadas em ambiente seguro e controlado.

Nesse processo, podem ser coletadas informações públicas do dispositivo, tais como IP, sistema operacional, entre outras, através do uso de ferramentas terceiras com a finalidade de coletar insumos sobre a utilização da ferramenta para futuras melhorias.

A ClearSale tem interesse legítimo em fornecer serviços de prevenção à fraude a partir de formação de perfis comportamentais, os quais são lícitos e representam uma finalidade legítima, considerada a partir de situações concretas, tal como exigido pela LGPD.

Mais informações de como estamos preocupados e atuando para cumprimento da LGPD, veja o link.

O Produto

Através de SDKs disponíveis em Android e iOS, é possível capturar frente e verso de documentos utilizando a câmera do dispositivo do usuário. O fluxo padrão compreende:

Solicitação de permissão de acesso à câmera
Instruções para uma boa captura
Feedbacks em caso de capturas inválidas/descartes
Captura e revisão da foto da face da frente do documento
Captura e revisão da foto da face do verso do documento
Envio das capturas da frente e verso do documento

As imagens enviadas pelos usuários podem ser resgatadas através de uma consulta na API.

Regras de Segurança

Bloqueio de uso de câmera em modo paisagem em dispositivos móveis e tablets
Se o PAT for salvo em um repositório git, mesmo que seja um repositório privado, ele corre risco de ser considerado exposto e ser automaticamente desativado por motivos de segurança

Dados

Entrada:

clientID
clientSecret
identifierId
cpf (opcional)

Retorno

Id da sessão (ID único da sessão, utilizado para a recuperação da imagem)
Tipo do documento capturado

Requisitos de Atualização

Periodicamente serão divulgadas novas versões dos SDKs via e-mail. Manter seus SDKs atualizados na última versão garante maior segurança e usabilidade para os usuários de seus aplicativos.

Detalhes de privacidade

Uso de dados

Todas as informações coletadas pelo SDK da ClearSale são com exclusiva finalidade de prevenção à fraude e proteção ao próprio usuário, aderente à política de segurança e privacidade das plataformas Google e Apple e à LGPD. Por isso, estas informações devem constar na política de privacidade do aplicativo.

Tipo de dados coletados

O SDK da ClearSale coleta as seguintes informações do dispositivo :

Características físicas do dispositivo/ hardware (Como tela, modelo, nome do dispositivo);
Características de software (como versão, idioma, build, controle parental);
Informações de rede (como conexões, IP);

Algumas dessas informações podem vir a serem compartilhadas com nossas ferramentas de monitoria e error tracking.

Documentação técnica

Plataforma	Documentação
iOS latest	Clique Aqui
Android latest	Clique Aqui

Recuperação da imagem aprovada na Captura de Documentos

É possível recuperar as imagens nos nossos servidores através do campo sessionId informado na response dos nossos SDKs. Para isso, é preciso autenticar na nossa API, recuperar o token de autenticação e utilizá-lo para fazer uma chamada e recuperar as imagens. Abaixo um passo a passo de como realizar esse processo.

Exemplo

Primeiramente faça a chamada de autenticação passando os seguintes parâmetros:

clientId - identifica o cliente junto à ClearSale. É o mesmo valor fornecido pela ClearSale para a utilização dos SDKs.
clientSecret - chave de autenticação da ClearSale. É o mesmo valor fornecido pela ClearSale para a utilização dos SDKs.

Requisição no ambiente de produção

POST https://documentoscopysdk.clearsale.com.br/api/v2/authentication
Content-Type: application/json
{
    "clientId": "*******",
    "clientSecret": "*******"
}

Requisição no ambiente de Homologação

POST https://documentoscopysdk-hml.clearsale.com.br/api/v2/authentication
Content-Type: application/json
{
    "clientId": "*******",
    "clientSecret": "*******"
}

Resposta de sucesso

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "accessToken":"*******",
    "expiresIn": 300,
    "tokenType": "Bearer",
}

Resposta de erro 401

HTTP/1.1 401 OK
Content-Type: application/json; charset=utf-8
{
    "title": "An error occurred with client credentials.",
    "status": 401,
    "instance": "/api/v2/authentication"
}

Resposta de erro 500

HTTP/1.1 500 InternalServerError
Content-Type: application/json; charset=utf-8
{
    "title": "Unespected server error. Please try again later",
    "status": 500,
    "instance": "/api/v2/document"
}

Em caso de sucesso, você receberá o accessToken que é necessário para fazer a chamada para recuperação da imagem. Para isso você deve fazer a seguinte chamada substituindo o parâmetro SESSIONID pelo valor do sessionId que foi retornado pelo SDK. Para saber como recuperar o SessionID:

no SDK iOS clique aqui.
no SDK Android clique aqui.

Requisição no ambiente de produção

GET https://documentoscopysdk.clearsale.com.br/api/v2/document/SESSIONID HTTP/1.1
Content-Type: application/json
Authentication: Bearer accessToken

Requisição no ambiente de homologação

GET https://documentoscopysdk-hml.clearsale.com.br/api/v2/document/SESSIONID HTTP/1.1
Content-Type: application/json
Authentication: Bearer accessToken

Resposta de sucesso

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{ 
    "identifierId": "<ID único de rastreamento da transação>"
    "sessionId": "<SESSIONID>",
    "documentType": "<rg|cnh>",
    "images": [
                {
                    "side":"<front|back>",
                    "base64":"<base64>"
                },
                                {
                    "side":"<front|back>",
                    "base64":"<base64>"
                },
    ],
}

Resposta de erro 401

HTTP/1.1 401 OK
Content-Type: application/json; charset=utf-8
{
    "title": "AccessToken is improperly formatted.",
    "status": 401,
    "instance": "/api/v2/document/SESSIONID"
}

Resposta de erro 500

HTTP/1.1 500 InternalServerError
Content-Type: application/json; charset=utf-8
{
    "title": "Unespected server error. Please try again later",
    "status": 500,
    "instance": "/api/v2/document"
}

Licença de Uso

Ao realizar o download e utilizar nosso SDK você estará concordando com a seguinte licença:

Todos os direitos são reservados, sendo concedida a permissão para usar o software da maneira como está, não sendo permitido qualquer modificação ou cópia para qualquer fim. O Software é licenciado com suas atuais configurações “tal como está” e sem garantia de qualquer espécie, nem expressa e nem implícita, incluindo mas não se limitando, garantias de comercialização, adequação para fins particulares e não violação de direitos patenteados. Em nenhuma hipótese os titulares dos Direitos Autorais podem ser responsabilizados por danos, perdas, causas de ação, quer seja por contrato ou ato ilícito, ou outra ação tortuosa advinda do uso do Software ou outras ações relacionadas com este Software sem prévia autorização escrita do detentor dos direitos autorais.