{"info":{"_postman_id":"48fbc02a-ac57-4dd8-9a59-a717531fcc89","name":"MeuID: Obtendo dados de usuários","description":"

Requests que compõem o fluxo de integração para acesso dos dados do usuário entre o MeuID e empresas clientes. Esse é o fluxo que deve ser executado após o usuário autorizar que a empresa cliente acesse os dados presentes na carteira do MeuID.

As requests devem ser feitas no fluxo aqui descrito (1, 2 e, por fim, 3).

Favor dar atenção especial aos pontos descritos como Importantes nas descrições dos endpoints.

Pré-requisitos

Para conseguir completar este fluxo é necessário disponibilizar um endpoint HTTPS para onde o MeuID enviará os dados de autorização do usuário.

Esse endpoint será responsável por fazer o processo de obtenção dos dados do usuário descrito neste documento.

Segue, agora, a descrição detalhada das necessidades dessa rota.

Fluxo com webhook X fluxo com WebView

Existem duas formas de criação desse endpoint, que dependem de qual tipo de fluxo a empresa cliente usa no MeuID:

O fluxo com webhooks, onde todo o processo é feito server-side e o usuário não sai do ambiente do app MeuID;
E o fluxo com webview, onde o endpoint referido anteriormente é uma página web para a qual o app MeuID redirecionará o usuário.

Fluxo com webhook

Caso a empresa utilize o fluxo com webhook, o endpoint deverá estar presente num serviço web, atendendo as seguintes guidelines:

O servidor deverá ter SSL, não é suportado fluxo apenas com HTTP;
A URL do endpoint é de livre escolha, mas ela deverá ser acessível pelo verbo HTTP GET;
Ela deverá receber pelo menos dois parâmetros obrigatórios:
- code: É o código do processo de autorização do usuário. Servirá de insumo para a obtenção dos dados pessoais;
- code_verifier: É um código verificador do processo de autorização. Também servirá de insumo para obtenção dos dados pessoais.
\n

Ao receber esses dados, o back-end deve seguir os passos descritos no restante deste documento.

Fluxo com webview

Caso a empresa utilize o fluxo com webview, o endpoint descrito deverá ser uma página web que atenda aos seguintes requisitos:

O servidor deverá ter SSL, não é suportado fluxo apenas com HTTP;
Ela deverá receber pelo menos dois parâmetros obrigatórios:
- code: É o código do processo de autorização do usuário. Servirá de insumo para a obtenção dos dados pessoais;
- code_verifier: É um código verificador do processo de autorização. Também servirá de insumo para obtenção dos dados pessoais.
\n

IMPORTANTE

Após receber esses dados, a página deve enviá-los para um back-end da empresa cliente, para que esse back-end siga os passos descritos no restante deste documento.\nIsso é de extrema importância, para que a combinação de dados sigilosa de clientId/secret da empresa cliente não fique exposta na internet.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Pré-requisitos","slug":"pre-requisitos"}],"owner":"3977334","collectionId":"48fbc02a-ac57-4dd8-9a59-a717531fcc89","publishedId":"SzYUa21Q","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5500FF"},"publishDate":"2020-03-26T17:00:49.000Z"},"item":[{"name":"1. Obter token de acesso aos dados do usuário","id":"73eeb643-67ba-48a6-b450-670dfc041851","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"authorization_code\": \"{{code}}\",\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"code_verifier\": \"{{code_verifier}}\"\n}"},"url":"https://api-v3.idwall.co/token","description":"

Request onde é feita a troca do código de autorização (code) obtido anteriormente pelo token de acesso (access_token) aos dados do usuário.

Payload

Os campos indicados como 'fixo' não devem ser alterados.

authorization_code: Código de autorização (code) recebido do fluxo anterior.
grant_type (fixo): Valor que indica o tipo de autorização que foi feita.
client_id (fixo): Identificador interno (appId) da sua empresa na plataforma da idwall.
client_secret (fixo): Identificador privado da sua empresa na plataforma da idwall.
code_verifier: Código de verificação de segurança recebido do fluxo anterior. Seu envio só é obrigatório caso tenha sido recebido do fluxo anterior.

Resposta

HTTP 200
JSON contendo um campo access_token e um campo refresh_token. Ex.:

{\n    \"access_token\": \"eyJhbGciOiJSUzI1Ni...2Np6HLCKp_Ua4cGiww\",\n    \"refresh_token\": \"wxnyzLzcJPivqm...tTkmaAuUNoakNjQSZqgkJ\",\n    \"expires_at\": \"Tue Nov 12 15:32:17 UTC 2019\",\n    \"token_type\": \"Bearer\"\n}\n

Observações importantes

O campo access_token contém o token de autorização que deverá ser utilizado para obter os dados do cliente (na request 2. Obter dados).
Por razões de segurança no processo, o token retornado em access_token tem um curto tempo de expiração (120 segundos).
É possível obter um novo access_token utilizando o token refresh_token. Esse processo é descrito na request 3. Obtendo novo access_token.
O token refresh_token tem um tempo de expiração maior (que é o tempo configurado no cadastro da sua empresa). A data final de expiração do refresh_token é retornada no campo expires_at deste endpoint.
Passado o tempo de expiração do refresh_token, é necessário repetir o processo de autorização do usuário para obtenção de novas credenciais (access_token e refresh_token).

\n","urlObject":{"path":["token"],"host":["https://api-v3.idwall.co"],"query":[],"variable":[]}},"response":[{"id":"ec4f6d16-92b9-423e-9517-db49f7b4db59","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authorization_code\": \"{{code}}\",\n \"grant_type\": \"authorization_code\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"code_verifier\": \"{{code_verifier}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3.idwall.co/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"access_token\": \"{{access_token_value}}\"\n}"}],"_postman_id":"73eeb643-67ba-48a6-b450-670dfc041851"},{"name":"2. Obter dados","id":"56c199b7-ecab-4436-b0e7-335f77bb1dce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"{{valor de 'access_token' aqui}}"}],"url":"https://api-v3.idwall.co/meuid/data","description":"

Request onde é feita a obtenção em si dos dados pessoais do usuário.

Headers

Authorization: O valor de access_token recebido na request anterior (1. Obter código de acesso aos dados).

Resposta

HTTP 200
Body contendo os dados aos quais o usuário permitiu acesso.

Observações importantes

Por mais que no exemplo de resposta dessa request nós tenhamos disponiblizado o formato completo de retorno dos dados do usuário (com todos os dados possíveis), no caso de uso real serão retornados apenas os dados aos quais o usuário permitiu o acesso.

\n","urlObject":{"path":["meuid","data"],"host":["https://api-v3.idwall.co"],"query":[],"variable":[]}},"response":[{"id":"1c1e5f0c-a691-4f48-b805-608a61697e0d","name":"Sucesso","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{access-token}}","type":"text"}],"url":"https://api-v3.idwall.co/meuid/data"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"personal\": {\n \"email\": \"\",\n \"phoneNumber\": \"\"\n },\n \"biometric\": {\n \"faceImageUrl\": \"\"\n },\n \"document\": {\n \"rg\": {\n \"numeroRg\": \"\",\n \"birthDate\": \"\",\n \"name;\": \"\",\n \"dataExpedicao\": \"\",\n \"fathersName\": \"\",\n \"mothersName\": \"\",\n \"cidadeNascimento\": \"\",\n \"numeroCpf\": \"\",\n \"orgaoExpeditor\": \"\",\n \"ufExpedicao\": \"\",\n \"imageUrls\": [\n {\n \"type\": \"FRONT\",\n \"url\": \"https://url-da-imagem.com.br/rg-front.jpg\"\n },\n {\n \"type\": \"BACK\",\n \"url\": \"https://url-da-imagem.com.br/rg-back.jpg\"\n }\n ]\n },\n \"cnh\": {\n \"acc\": \"\",\n \"registro\": \"\",\n \"espelhoFrente\": \"\",\n \"espelhoVerso\": \"\",\n \"seguranca\": \"\",\n \"renach\": \"\",\n \"categoria\": \"\",\n \"dataExpiracao\": \"\",\n \"primeiraHabilitacao\": \"\",\n \"dataExpedicao\": \"\",\n \"ufExpedicao\": \"\",\n \"ufExpedicaoRg\": \"\",\n \"orgaoEmissorRg\": \"\",\n \"numeroCpf\": \"\",\n \"numeroRg\": \"\",\n \"name\": \"\",\n \"birthDate\": \"\",\n \"mothersName\": \"\",\n \"fathersName\": \"\",\n \"cidadeExpedicao\": \"\",\n \"permissao\": \"\",\n \"observacao\": \"\",\n \"imageUrls\": [\n {\n \"type\": \"FULL\",\n \"url\": \"https://url-da-imagem.com.br/cnh-full.jpg\"\n }\n ]\n },\n \"crm\": {\n \"numero\": \"\",\n \"uf\": \"\"\n }\n }\n }\n}"}],"_postman_id":"56c199b7-ecab-4436-b0e7-335f77bb1dce"},{"name":"3. Obtendo novo access_token","id":"0d5db4c4-f44a-4f09-9c06-352e2c0252e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"refresh_token\": {{valor de 'refresh_token' aqui}},\n \"grant_type\": \"refresh_token\",\n \"client_id\": \"3a46ec5a-b463-4069-bb9f-138715901d9d\",\n \"client_secret\": \"{{application-secret}}\"\n}"},"url":"https://api-v3.idwall.co/token","description":"

Request onde é feita a obtenção de um novo token de acesso aos dados (access_token) a partir de um refresh_token ainda válido.

Payload

Os campos indicados como 'fixo' não devem ser alterados.

refresh_token: Valor de refresh_token, ainda válido, obtido na request 2. Obter código de acesso aos dados.
grant_type (fixo): Valor que indica o tipo de autorização que foi feita.
client_id (fixo): Identificador interno (appId) da sua empresa na plataforma da idwall.
client_secret (fixo): Identificador privado da sua empresa na plataforma da idwall.

Resposta

HTTP 200
JSON contendo um campo access_token. Ex.:

{\n    \"access_token\": \"eyJhbGciOiJSUzI1Ni...2Np6HLCKp_Ua4cGiww\",\n    \"expires_at\": \"Tue Nov 12 15:32:17 UTC 2019\",\n    \"token_type\": \"Bearer\"\n}\n

Observações importantes

No campo access_token é retornado um novo código de acesso aos dados, válido por mais 120 segundos.
Ao contrário do endpoint 1. Obter código de acesso, o campo expires_at da resposta desse endpoint contém a data de expiração do código de acesso (access_token) gerado.

\n","urlObject":{"path":["token"],"host":["https://api-v3.idwall.co"],"query":[],"variable":[]}},"response":[{"id":"12d5665f-a093-4bfd-afd4-58d76e141332","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"refresh_token\": {{valor de 'refresh_token' aqui}},\n \"grant_type\": \"refresh_token\",\n \"client_id\": \"{{ambev-application-id}}\",\n \"client_secret\": \"{{ambev-application-secret}}\"\n}"},"url":"https://api-v3.idwall.co/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Nov 2019 18:18:29 GMT"},{"key":"Content-Type","value":"application/json;charset=ISO-8859-1"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"https://auth.idwall.co"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-type"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"IDW-Request-ID","value":"de2bd07e-001a-47dc-b3c2-4d01dc02a749"},{"key":"Content-Encoding","value":"gzip"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"53214f5a7e724c2e-GRU"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1...AzJBhjWracg2PO1osnIazA\",\n \"expires_at\": \"Thu Nov 07 18:20:29 UTC 2019\",\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"0d5db4c4-f44a-4f09-9c06-352e2c0252e2"}],"event":[{"listen":"prerequest","script":{"id":"6ec374f5-a9a1-4eac-b58a-91c4f18c2c82","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4379b995-6e92-4a2d-9a06-e2cf6d9b02b8","type":"text/javascript","exec":[""]}}],"variable":[{"key":"idwall-api-host","value":"https://api-v3.idwall.co"},{"key":"application-id","value":"3a46ec5a-b463-4069-bb9f-138715901d9d"},{"key":"redirect-uri","value":"https://vending-machine.ambev.com/redirect"}]}