openapi: 3.1.0 info: title: MetaMap API version: '1.4' description: MetaMap (formerly Mati) identity verification REST API. Start and manage user verifications, retrieve verification media, run watchlist, email, phone, credit, court-record, and government database checks across Latin America, Africa, and Asia. contact: name: MetaMap url: https://metamap.com license: name: MetaMap Terms of Service url: https://metamap.com/legal/terms-of-service servers: - url: https://api.prod.metamap.com description: Production tags: - name: Authentication - name: Background Checks - name: Credit Checks - name: Custom Watchlists - name: Email Checks - name: GovChecks - name: Phone Checks - name: Verifications - name: Watchlist Checks - name: Webhooks components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: JWT obtained via POST /oauth using client_id / client_secret as HTTP Basic. basicAuth: type: http scheme: basic description: Used only on POST /oauth for the initial token exchange. schemas: {} security: - bearerAuth: [] paths: /oauth/token: post: summary: Authentication Token description: Use this API to get your access token for the Skip Verification Upload Wait Time API operationId: authentication-token parameters: - name: x-mati-app in: header description: platform=web_desktop; version=22.2.10 required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object required: - grant_type - scope properties: grant_type: type: string default: client_credentials application_key: type: string description: client ID scope: type: string default: verification_flow flow_id: type: string description: Your metamap (flow) ID responses: '200': description: '200' content: application/json: examples: Mati Access Token: value: "{\n \"access_token\": \"\",\n \"expires_in\": 3600,\n \"scope\": \"verification_flow\"\ ,\n \"token_type\": \"bearer\"\n}" schema: type: object properties: access_token: type: string example: expires_in: type: integer example: 3600 default: 0 scope: type: string example: verification_flow token_type: type: string example: bearer '400': description: '400' content: application/json: examples: Invalid Client: value: "{\n \"code\": 400,\n \"message\": \"Invalid client: cannot retrieve client credentials\",\n \"\ name\": \"invalid_client\",\n \"status\": 400,\n \"statusCode\": 400\n}" schema: type: object properties: code: type: integer example: 400 default: 0 message: type: string example: 'Invalid client: cannot retrieve client credentials' name: type: string example: invalid_client status: type: integer example: 400 default: 0 statusCode: type: integer example: 400 default: 0 '401': description: '401' content: application/json: examples: Result: value: "{\n \"code\":401,\n \"message\":\"Invalid client: client is invalid\",\n \"name\":\"invalid_client\"\ ,\n \"status\":401,\n \"statusCode\":401\n}\n" schema: type: object properties: code: type: integer example: 401 default: 0 message: type: string example: 'Invalid client: client is invalid' name: type: string example: invalid_client status: type: integer example: 401 default: 0 statusCode: type: integer example: 401 default: 0 deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/oauth/token' \\\n-H 'x-mati-app: platform=web_desktop;\ \ version=22.2.10' \\\n-H \"Authorization: Basic \\\n$(echo -en ':' | base64)\" \\\n\ -d '{\n \"grant_type\": \"application_key\",\n \"application_key\": \"\",\n \"scope\": \"\ verification_flow\",\n \"flow_id\": \"\"\n }'" name: Sample Authentication Request samples-languages: - curl tags: - Authentication /oauth: post: summary: Authentication description: Use your `client_id` and `client_secret` as your username and password to get your access token. operationId: authentication requestBody: content: application/x-www-form-urlencoded: schema: type: object required: - grant_type properties: grant_type: type: string default: client_credentials responses: '200': description: '200' content: application/json: examples: Mati Access Token: value: "{\n \"access_token\": \"YOUR_MATI_ACCESS_TOKEN\",\n \"expiresIn\": 3600,\n \"payload\": {\n \ \ \"user\": {\n \"_id\": \"\"\n }\n }\n}" schema: type: object properties: access_token: type: string example: YOUR_MATI_ACCESS_TOKEN expiresIn: type: integer example: 3600 default: 0 payload: type: object properties: user: type: object properties: _id: type: string example: '400': description: '400' content: application/json: examples: Invalid Client: value: "{\n \"code\": 400,\n \"message\": \"Invalid client: cannot retrieve client credentials\",\n \"\ name\": \"invalid_client\",\n \"status\": 400,\n \"statusCode\": 400\n}" schema: type: object properties: code: type: integer example: 400 default: 0 message: type: string example: 'Invalid client: cannot retrieve client credentials' name: type: string example: invalid_client status: type: integer example: 400 default: 0 statusCode: type: integer example: 400 default: 0 '401': description: '401' content: application/json: examples: Result: value: "{\n \"code\":401,\n \"message\":\"Invalid client: client is invalid\",\n \"name\":\"invalid_client\"\ ,\n \"status\":401,\n \"statusCode\":401\n}\n" schema: type: object properties: code: type: integer example: 401 default: 0 message: type: string example: 'Invalid client: client is invalid' name: type: string example: invalid_client status: type: integer example: 401 default: 0 statusCode: type: integer example: 401 default: 0 deprecated: false tags: - Authentication /backgroundchecks/v1/br/background: post: summary: 'Brazil: Court Records' description: Use this API to check for users for court records in Brazil operationId: brazil-court-records requestBody: content: application/json: schema: type: object required: - fullName - cpf - callbackUrl - dateOfBirth - fullCheck properties: fullName: type: string description: User's full name cpf: type: string description: "User's Registration of Individuals (Cadastro de Pessoas F\xEDsicas / CPF) number" callbackUrl: type: string description: Callback URL to receive data. dateOfBirth: type: string format: date fullCheck: type: boolean description: Use `true` for the full background check. responses: '200': description: '200' content: application/json: examples: 'Full Check: No Criminal Records Found': value: "{\n \"error\": null,\n \"data\": {\n \"fullName\": \"JOHN DOE\",\n \"cpf\": \"00000000000\"\ ,\n \"dateOfBirth\": \"1980-01-01\",\n \"status\": \"Accepted\",\n \"fullBackgroundCheck\": {\n\ \ \"search\": {\n \"id\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\",\n \"tags\": {\n\ \ \"identityId\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\"\n },\n \"BranchId\"\ : 278,\n \"isStatusTemporary\": true,\n \"status\": \"preApproved\",\n \"createdAt\"\ : \"2021-07-07T11:14:48.342Z\",\n \"receivedNotifiableStatusAt\": \"2021-07-07T11:20:59.956Z\"\ ,\n \"finishedProcessingAt\": null,\n \"priorityFinishedProcessingAt\": \"2021-07-07T11:20:59.956Z\"\ ,\n \"exceptionListStatus\": null,\n \"notifiedWebhookAt\": null,\n \"officialNameStatus\"\ : \"match\",\n \"candidate\": {\n \"officialName\": \"JOHN DOE\",\n \"name\"\ : \"JOHN DOE\",\n \"cpf\": \"00000000000\",\n \"birthday\": \"1980-01-01\"\n \ \ },\n \"receivedFinalStatusAt\": \"2021-07-07T11:20:59.956Z\",\n \"results\": [\n \ \ {\n \"id\": 123895176,\n \"crawler\": \"ACTJRG\",\n \"crawlerFullName\"\ : \"Tribunal da Justi\xC3\xA7a do Acre (Busca por RG)\",\n \"isCertificate\": false,\n \ \ \"status\": \"invalidInput\",\n \"linkEvidence\": null,\n \"finishedProcessingAt\"\ : \"2021-07-07T11:14:50.000Z\",\n \"ignored\": false,\n \"review\": null,\n \ \ \"certificate\": null,\n \"trials\": []\n },\n {\n \"\ id\": 123895177,\n \"crawler\": \"RJJFCP\",\n \"crawlerFullName\": \"Justi\xC3\xA7\ a Federal do Rio de Janeiro (Consulta Processual)\",\n \"isCertificate\": false,\n \ \ \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzExYjMzNWYzLTkxNWUtNGQwNC05NTM5LTljOWMyMDY2MWE4Mi83ZTgxOWZkNC1lZTRmLTQxOWQtYjcwYy0zMmNiNWU0NTYzNWEvP3JlZ2lvbj11cy1lYXN0LTE.WvQjhZdh5nyJFjtf22uCuQ6WI_fYO-z2QCALt5TKr0k\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:43.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895178,\n \"crawler\": \"SCTJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Santa Catarina (Busca por CPF)\",\n \ \ \"isCertificate\": false,\n \"status\": \"processing\",\n \"linkEvidence\"\ : null,\n \"finishedProcessingAt\": null,\n \"ignored\": true,\n \"review\"\ : null,\n \"certificate\": null,\n \"trials\": []\n },\n {\n \ \ \"id\": 123895179,\n \"crawler\": \"SPTJRG\",\n \"crawlerFullName\"\ : \"Tribunal da Justi\xC3\xA7a de S\xC3\xA3o Paulo (Busca por RG)\",\n \"isCertificate\": false,\n\ \ \"status\": \"invalidInput\",\n \"linkEvidence\": null,\n \"finishedProcessingAt\"\ : \"2021-07-07T11:14:50.000Z\",\n \"ignored\": false,\n \"review\": null,\n \ \ \"certificate\": null,\n \"trials\": []\n },\n {\n \"\ id\": 123895180,\n \"crawler\": \"PETJ\",\n \"crawlerFullName\": \"Tribunal de Justi\xC3\ \xA7a de Pernambuco\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n\ \ \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzk2MzlkNTY0LTcxOWMtNDVjZS05NzNhLTAwMWJmNmQxYzhjNC9mZmE4NGQxZi04ODkzLTRiNDQtODViZi05NjY1OTUyMGM2ODYvP3JlZ2lvbj11cy1lYXN0LTE.M_YHvaHbAbJPPCp6CDFnfLoxc3s2JeUphAcIWwqcxWs\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:59.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895181,\n \"crawler\": \"ALTJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Alagoas (Busca por CPF)\",\n \"\ isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzIzNDNjOTVhLTI0NDEtNDY0ZS05ZTVmLWI5NDY0OWZmYWE0ZC84YzI2MjFkOC1mYThjLTQ5OWYtYWFiNy0wNTE0YzU2YTdjYjAvP3JlZ2lvbj11cy1lYXN0LTE.YND1LUGdiPjMI71kz-240HQm10ff9vFfAL3XczDncho\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:50.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895182,\n \"crawler\": \"MSTJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Mato Grosso do Sul (Busca por CPF)\",\n \ \ \"isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\"\ : \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2YyZDljOWNkLTBmZjUtNDc2Ny1iZDA0LTU2MjNhZjQ2ZTJiMS9mNTI2OGQ4Ny0zOWVkLTQ3YjMtYjFiMi1mZmU1MjllMTM4NGMvP3JlZ2lvbj11cy1lYXN0LTE.SJokNWn1VDQ5Vzgfiwit6Q168MCjyzE7tavQafICy7w\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:19:41.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895183,\n \"crawler\": \"SPTJSICPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de S\xC3\xA3o Paulo (Segunda inst\xC3\xA2ncia\ \ - Busca por CPF)\",\n \"isCertificate\": false,\n \"status\": \"processing\",\n\ \ \"linkEvidence\": null,\n \"finishedProcessingAt\": null,\n \"ignored\"\ : false,\n \"review\": null,\n \"certificate\": null,\n \"trials\": []\n\ \ },\n {\n \"id\": 123895184,\n \"crawler\": \"SCTJRG\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Santa Catarina (Busca por RG)\",\n \ \ \"isCertificate\": false,\n \"status\": \"invalidInput\",\n \"linkEvidence\"\ : null,\n \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\",\n \"ignored\"\ : false,\n \"review\": null,\n \"certificate\": null,\n \"trials\": []\n\ \ },\n {\n \"id\": 123895185,\n \"crawler\": \"TRF3PJESI\",\n\ \ \"crawlerFullName\": \"Processo Jur\xC3\xADdico Eletr\xC3\xB4nico da Justi\xC3\xA7a Federal\ \ da 3\xC2\xAA Regi\xC3\xA3o (Segunda Inst\xC3\xA2ncia)\",\n \"isCertificate\": false,\n \ \ \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzQyNmYxOWI2LTI5Y2MtNGI4ZC04Yjc4LTE2MDFlOWU1MDA4OS84N2EzYWNmNy1jNTQ3LTQyZmQtOTRhMC03MDRkYjcyNzY3YjUvP3JlZ2lvbj11cy1lYXN0LTE.p9myT9nDB2P4mLxQTxOu7fE7sIdAF2T0HL6IiFXe4bM\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:18:38.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895186,\n \"crawler\": \"ROTJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Rond\xC3\xB4nia (Busca por CPF)\",\n \ \ \"isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\"\ : \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2RiZmZjMzMwLWZiOWEtNDkwZC04YTliLWM5MTMwNDI2MjIyYy81OTJmMjUyZC00YzIyLTRhMDAtOTNhOS1lNzBlZmMyZWMzNDQvP3JlZ2lvbj11cy1lYXN0LTE.YFQQgIbeMNls8DmXTxBqFF7epis64TK3MsXwb4KmYCk\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:20:57.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895187,\n \"crawler\": \"PRTJSI\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Paran\xC3\xA1 (Segunda Inst\xC3\xA2ncia)\",\n\ \ \"isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\"\ : \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2I2NzU1YmMwLTQzN2MtNGUzNi04ZTM2LWZmMDdhMTRhZmE3Zi9mNzYzZjQ5OS1kNzNlLTRkOWItYTE0Yi0zOGNlZmI3MDkxNmEvP3JlZ2lvbj11cy1lYXN0LTE.enxBOo7b_QIUCHWcH8Pl8SAUBgJSJ771A8ncHaOWGXI\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:43.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895188,\n \"crawler\": \"SETJ\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Sergipe\",\n \"isCertificate\": false,\n\ \ \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzdkMjNjYzA5LWU1ZjEtNDhkMy1hMzljLTk3NDQ1NDM4ODE4MS9jMjFmNjJmMi0zYTU3LTRhNGMtODA0MS00NzFkYWU0ZmMzZjgvP3JlZ2lvbj11cy1lYXN0LTE.LRg03FZp-de2tzrGqmnRG5PctRNgcd1_3gJamsJvk7o\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:55.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895189,\n \"crawler\": \"MSTJRG\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Mato Grosso do Sul (Busca por RG)\",\n \ \ \"isCertificate\": false,\n \"status\": \"invalidInput\",\n \"linkEvidence\"\ : null,\n \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\",\n \"ignored\"\ : false,\n \"review\": null,\n \"certificate\": null,\n \"trials\": []\n\ \ },\n {\n \"id\": 123895190,\n \"crawler\": \"MGJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal de Minas Gerais Tribunal Regional Federal da\ \ 1\xC2\xAA Regi\xC3\xA3o\",\n \"isCertificate\": false,\n \"status\": \"approved\"\ ,\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzUyNDViYWFlLTQ5NjItNDhmOC05NGJjLWY4YWYxNGUxN2E1NC9hM2UyYjJmZi0xZTBkLTRiNzEtYTI2Yi04ZGJlNTJmYjA3ZjMvP3JlZ2lvbj11cy1lYXN0LTE.hjko_3rAOSen3_kaVb2PiRUXDMoxT7JWTehq6fKAeXw\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:46.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895191,\n \"crawler\": \"RNTJRG\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Rio Grande do Norte (Busca por RG)\",\n \ \ \"isCertificate\": false,\n \"status\": \"invalidInput\",\n \"linkEvidence\"\ : null,\n \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\",\n \"ignored\"\ : false,\n \"review\": null,\n \"certificate\": null,\n \"trials\": []\n\ \ },\n {\n \"id\": 123895192,\n \"crawler\": \"APTJ\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Amap\xC3\xA1\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzc5M2IzNmZiLTdmMGMtNDM3Ni1hZjRmLTgzZDdkMDcyMTFmMS8yY2UzMTRiZS0zYWYxLTRiNjQtYTM1Mi1lNTMzZDBkODE5Y2EvP3JlZ2lvbj11cy1lYXN0LTE.KowPdzhDCJXui2nvQf6QJGsm5HvJRRPhXDLXDgwOUb4\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:52.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895193,\n \"crawler\": \"ACJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Acre Tribunal Regional Federal da 1\xC2\xAA Regi\xC3\ \xA3o\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"\ linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzQ1OWI5NzU3LTMwNDItNGNkMi1hYWRiLWIyMDYyOWY0MDRjYi8yYTg5YmYxMy0zZTBhLTQ1NjEtODhhYy0yYTE3YWE2MTg5YWYvP3JlZ2lvbj11cy1lYXN0LTE.iVz1pEREfI5aBf0gRJa2tMzLO5CVlhs7WbwW5l1Tx-Q\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:54.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895194,\n \"crawler\": \"GOTJ\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Goi\xC3\xA1s\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzVmNjZkMzFiLTJiY2MtNDQyNS04NzA3LTk2MDQ2YjM2MzkyOC81Y2Q1NWMzMS1lNWI3LTQ0MTQtYjYyYy1iNGFhNjM4ZGVmZGEvP3JlZ2lvbj11cy1lYXN0LTE.Tjkr5TwUURq-eqN7KL9IHMBEdANs_hYkhi8EzGHndm4\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:54.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895195,\n \"crawler\": \"AMTJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Amazonas (Busca por CPF)\",\n \"\ isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzcwODNmNmIwLWEyNGQtNDNhYS04NTI4LWNmZjQxMjhlOTk1OS80MjM3M2I5NC1mMTk5LTRlNTMtYTg1NS00NzFiMDM4YjgyM2QvP3JlZ2lvbj11cy1lYXN0LTE.wWFo6HZy_Kql5KvOy6kWbgQXoIyIc6GsZLwsGt1EeAo\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:18:41.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895196,\n \"crawler\": \"CETJRG\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Cear\xC3\xA1 (Busca por RG)\",\n \ \ \"isCertificate\": false,\n \"status\": \"invalidInput\",\n \"linkEvidence\":\ \ null,\n \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\",\n \"ignored\"\ : false,\n \"review\": null,\n \"certificate\": null,\n \"trials\": []\n\ \ },\n {\n \"id\": 123895197,\n \"crawler\": \"PAJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Para Regional Federal da 1\xC2\xAA Regi\xC3\ \xA3o\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"\ linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzBmNTA3Y2Y5LTgzNGEtNGNlMi1iMTI4LTBmOTU5ZTNhMDc2Mi81NDQwNjgzNi1jYmVjLTQxZDEtOGQzYy0xZmM0MjIzYzUzODEvP3JlZ2lvbj11cy1lYXN0LTE._4t5ufjrztXZapTN96JzbvhB44V8KQ1Q-5kmDh1RRDQ\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:51.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895198,\n \"crawler\": \"MGTJ\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Minas Gerais\",\n \"isCertificate\"\ : false,\n \"status\": \"processing\",\n \"linkEvidence\": null,\n \"\ finishedProcessingAt\": null,\n \"ignored\": true,\n \"review\": null,\n \ \ \"certificate\": null,\n \"trials\": []\n },\n {\n \"id\"\ : 123895199,\n \"crawler\": \"TRF1PJESI\",\n \"crawlerFullName\": \"Processo Jur\xC3\ \xADdico Eletr\xC3\xB4nico da Justi\xC3\xA7a Federal da 1\xC2\xAA Regi\xC3\xA3o - Segunda Inst\xC3\xA2\ ncia\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"\ linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzYxY2Q5OTRmLWYxZGUtNDJkMi04ZTUxLWI1YTA4MDNiZjIzMC9iMWU0YjY5Yy0wMDFlLTRjNzAtOTMyNS1kMDA2Nzk3MDEyNDAvP3JlZ2lvbj11cy1lYXN0LTE.Lma6IFO7nb9Puln5xCjtTgvoTZs9VMAdYAHaktXR-co\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:46.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895200,\n \"crawler\": \"BATJSICPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a da Bahia (Segunda Inst\xC3\xA2ncia - Busca por\ \ CPF)\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"\ linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzE2N2JmYWZhLWIyZjgtNGEyZC1hODRjLTIyMDA1ZDNjZmE0Yy9hOTIyMDYxZi1jOTMxLTQ5NDItOTc4Mi0zMGE0NTg2YWQ3ZDgvP3JlZ2lvbj11cy1lYXN0LTE.Brn_uWZcP0GVut1ZZcbvN0LuL6p1UCGLP8p5TQfLTBg\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:53.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895201,\n \"crawler\": \"AMTJRG\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Amazonas (Busca por RG)\",\n \"isCertificate\"\ : false,\n \"status\": \"invalidInput\",\n \"linkEvidence\": null,\n \ \ \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\",\n \"ignored\": false,\n \ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n },\n\ \ {\n \"id\": 123895202,\n \"crawler\": \"MTTJ\",\n \"crawlerFullName\"\ : \"Tribunal da Justi\xC3\xA7a do Mato Grosso\",\n \"isCertificate\": false,\n \"\ status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzRiZDIxNjI3LTMxYmYtNDc1YS05ZjJiLTViZWJhMDkwMWFkYi9jYWExZWExOC0yMDQxLTQyNWUtYTU3OS01ZWE1M2M0YjZhNjkvP3JlZ2lvbj11cy1lYXN0LTE.j6OcVYYmaQk3NlHt2tYeDEYZsWwmPGRq0P5xslf2anQ\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:59.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895203,\n \"crawler\": \"BATJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal de Justi\xC3\xA7a da Bahia (Busca por CPF)\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2I0NWI0MjQ3LWQ1ODMtNGUwOC1iN2JkLWQ5YjBlNDk1MzI0MS8xOWQ4ZjFhZC1jZGIyLTQzMjktODEwOS1jY2UzNGEzOWRjMTEvP3JlZ2lvbj11cy1lYXN0LTE.m10mycyizKPXoWzcw6ZJA9rdBt4sry3Z_ywxZO48Vsk\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:18:00.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895204,\n \"crawler\": \"APJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Amap\xC3\xA1 Tribunal Regional Federal da 1\xC2\ \xAA Regi\xC3\xA3o\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n\ \ \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzhlYmNiOTRiLTA2ZWItNGFlNy04NGJlLTUzYzFhN2JlYzlmZi82N2FmNTExMy0xMzViLTRjZmEtYTVhMy04MjE4ZDhhYjVkOTUvP3JlZ2lvbj11cy1lYXN0LTE.oWqCKwsSeg2rjMHvgnoG1L-2mo82aXRQzw51L_-75pE\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:46.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895205,\n \"crawler\": \"GOJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal de Goias Tribunal Regional Federal da 1\xC2\xAA Regi\xC3\ \xA3o\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"\ linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2Q2OGJlOGY2LTljZGItNGY3Yi05Y2VkLWMyOGE2Nzg3MmYxOS8wYWJkODAyMi0xMzQ0LTRhZWEtYWViYS1hOTExNmFiODQxOTkvP3JlZ2lvbj11cy1lYXN0LTE.Fc6yuC5NTM4PyKPeVSY2aZst67O7HMI1_nmyuItjHaU\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:53.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895206,\n \"crawler\": \"MTJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Mato Grosso Regional Federal da 1\xC2\xAA Regi\xC3\ \xA3o\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"\ linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzMxY2FkZDhkLTBlOGUtNGFhOC1iODBkLTYzZWQ2Y2ZjNzM1ZC9lYWMxMDQ2MS1hNDEzLTQyOGMtOGZlNi0xMWY3NWYwMTc4MmUvP3JlZ2lvbj11cy1lYXN0LTE.5a2u-fLAWNi0A8m1gPDpsxADM_da1nwBqUhAEYNdItg\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:44.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895207,\n \"crawler\": \"DFTJ\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Distrito Federal\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzFkODgyZGQzLThlMzctNGI0ZS05MjdkLWVkZmY3YjI5MDA1Mi9jNjI4YjVmZC1hM2ExLTQwNDUtOGNiZC1hZDAwNWQwNDM0OGEvP3JlZ2lvbj11cy1lYXN0LTE.wtJr2UG_jt3Wt1CaV7yE4XUFx2Jl8uaGODQXQIYyQS4\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:41.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895208,\n \"crawler\": \"TOJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Tocantis Regional Federal da 1\xC2\xAA Regi\xC3\ \xA3o\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"\ linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzBiNzllMTE4LTI5MzctNGIyOS1iN2I4LWJkYzY4NGZhOTI0YS8zN2VhZmEwOS00ZGI3LTQ2MDgtOWRmNi0xMzUxZDIzMjE2NWUvP3JlZ2lvbj11cy1lYXN0LTE.9Bv6eURIsliyJLgZP0mTjmAa7ec741Y77OUau-LSNwg\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:51.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895209,\n \"crawler\": \"RJTJ\",\n \ \ \"crawlerFullName\": \"Tribunal de Justi\xC3\xA7a do Rio de Janeiro\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzkwY2NlZDU0LWU5OWYtNDdiYS04ZGQyLTI0MWZhYjIzMzQzNC85M2JmNGRkNy0xZTRmLTQ2OTAtYTliZS04ODdiOGNjN2RiZWIvP3JlZ2lvbj11cy1lYXN0LTE.lTS5iobXx7o5hWryBANU9U3oA0-TyATFQQdgbrgB2f8\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:53.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895210,\n \"crawler\": \"RRTJSI\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Roraima (Segunda Inst\xC3\xA2ncia)\",\n \ \ \"isCertificate\": false,\n \"status\": \"processing\",\n \"linkEvidence\"\ : null,\n \"finishedProcessingAt\": null,\n \"ignored\": false,\n \"\ review\": null,\n \"certificate\": null,\n \"trials\": []\n },\n \ \ {\n \"id\": 123895211,\n \"crawler\": \"AMJFTRF1\",\n \"crawlerFullName\"\ : \"Justi\xC3\xA7a Federal do Amazonas Tribunal Regional Federal da 1\xC2\xAA Regi\xC3\xA3o\",\n \ \ \"isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\"\ : \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2QxZGZjNGY0LTg5YWEtNDE3Yi04ZDg0LTczZDIxMDY2NmE1MC9hOTkxYTZkZC05Y2JjLTRiOGUtYjA3Ni01ZThmZjdjMzgyMjIvP3JlZ2lvbj11cy1lYXN0LTE.E7RKxkzUUDbcyWudqBJ_2yXfwJfb9VyLLR3jFOZBIXo\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:52.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895212,\n \"crawler\": \"ACTJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Acre (Busca por CPF)\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzg2Mzg2YzgzLThiYmItNDU5Ny05NmJlLTQzYWM4NjUyYmNhOC8xYjhiNDhlOC00ODg0LTQ2OWQtOWU2ZS03ZjE4ZDM4MWNjNzIvP3JlZ2lvbj11cy1lYXN0LTE.-CNjLNdAijsgJUdhJErJvFZwzW3aW88F7GmAKoshCRc\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:18:38.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895213,\n \"crawler\": \"BAJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Bahia Tribunal Regional Federal da 1\xC2\xAA Regi\xC3\ \xA3o\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"\ linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzE0NDM0ZjdhLTc4MTAtNGI3Ni04MTgxLTkyOWU1YmM1ODE4Ny9hODE5YTdmMC1hNjBmLTRmN2YtOTFkNi01MzZmZjZkM2I5NmIvP3JlZ2lvbj11cy1lYXN0LTE.j76q8LK3r61M5LCPinMzc8xe58BI7KDG943kCa2GlpY\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:45.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895214,\n \"crawler\": \"ROTJSIRG\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Rond\xC3\xB4nia (Segunda Inst\xC3\xA2ncia\ \ - Busca por RG)\",\n \"isCertificate\": false,\n \"status\": \"invalidInput\"\ ,\n \"linkEvidence\": null,\n \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\"\ ,\n \"ignored\": false,\n \"review\": null,\n \"certificate\": null,\n\ \ \"trials\": []\n },\n {\n \"id\": 123895215,\n \"\ crawler\": \"ROTJRG\",\n \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Rond\xC3\xB4\ nia (Busca por RG)\",\n \"isCertificate\": false,\n \"status\": \"invalidInput\"\ ,\n \"linkEvidence\": null,\n \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\"\ ,\n \"ignored\": false,\n \"review\": null,\n \"certificate\": null,\n\ \ \"trials\": []\n },\n {\n \"id\": 123895216,\n \"\ crawler\": \"RRJFTRF1\",\n \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Roraima Regional\ \ Federal da 1\xC2\xAA Regi\xC3\xA3o\",\n \"isCertificate\": false,\n \"status\"\ : \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2E1OGI2NmY5LTM5NzItNDMyNS04NmMzLTVkZjMwYzc2OTRjNy8zOTdiNTQ2ZC00YjA1LTQ3N2EtOTg2YS1lNTM1YjI3ZTViYTUvP3JlZ2lvbj11cy1lYXN0LTE.qg-03hWNF3mLfmW1Qt-Ea5I0JYGx_H8ZA9qiC9ZJq38\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:45.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895217,\n \"crawler\": \"DFTJPJE\",\n \ \ \"crawlerFullName\": \"Processo Juridico Eletronico do Distrito Federal\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzhlMzUxNmUzLTUwMWEtNDIwOC04Mjc2LTU2NDA4ZWYyZWRkYy81ZWY4ODgzMi03NTc0LTQ5ZTgtYjRkOC05NDBmZjFiMTljOTIvP3JlZ2lvbj11cy1lYXN0LTE.B1CoXx-uBvKg7WddwxdjGZts7hNJcQFklDNpyB_H9Xw\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:18:38.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895218,\n \"crawler\": \"TRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal Tribunal Regional Federal da 1\xC2\xAA Regi\xC3\xA3o\"\ ,\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\"\ : \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzZmZWJiMTY3LWVjZWYtNDU0OS05MWE3LTA5NjVhZDJmOGFiYS84MjhiNzE5NS00ZDY0LTQxNTgtYTNjZC1lM2YzY2NkOTcwZDIvP3JlZ2lvbj11cy1lYXN0LTE.I2ylgARWKIADvcejwmCRYskT3OAPwyNKeFvU6h8laBI\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:51.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895219,\n \"crawler\": \"SPTJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de S\xC3\xA3o Paulo (Busca por CPF)\",\n \ \ \"isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\"\ : \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2ViMTk4ZWZjLWExYTItNGYzMy1hNmQ2LTkwNTIyN2IxMGYyMy8zMmZjYmQ5Ni1mZTcyLTQwMGUtYmMyMi0wYjA2MWM5MDMwZDkvP3JlZ2lvbj11cy1lYXN0LTE.3iMAzDv-udONSbbqplsMgU1gj3meYor_9VgNhbfjn0g\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:19:54.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895220,\n \"crawler\": \"PIJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Piaui Regional Federal da 1\xC2\xAA Regi\xC3\xA3\ o\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\"\ : \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzM3ZmM0ZjU0LTJmNmYtNDM5Yy1hMDViLTExMTE2ZTgzNDZjNC9jNmY1MDFjNy1iNDU3LTRkNWItODZkOS00OTk5NzNkOWE0MDYvP3JlZ2lvbj11cy1lYXN0LTE.RBVQWodRFE1uznJY5ShVAFfs7f-MOEl_yioOC3Tn2S0\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:51.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895221,\n \"crawler\": \"TRF2\",\n \ \ \"crawlerFullName\": \"Tribunal Regional Federal da 2\xC2\xAA Regi\xC3\xA3o\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzhjNTQ0ODhmLTZiNTktNDI0Yi1iMmY2LWZiMTY4MTkzNDUzMS8xYjRkZGZlNC00MmUzLTQyMDAtYmI3OS04MThmZDNmZWEyZmQvP3JlZ2lvbj11cy1lYXN0LTE.ly2yxSUvFvvvBk7REiGOLsqnI4EQZ_Cig8Rlfh6CLtI\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:44.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895222,\n \"crawler\": \"SPJF\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal de S\xC3\xA3o Paulo\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzYzMWQ2MzA0LWVlMWMtNDc3Ny04ZTM0LTQ1OTYzNzZmNDY4MC9jYTdkY2YwZS0wOWYzLTRjM2ItYWM4OC1lMzRmNDg2OWYyNDcvP3JlZ2lvbj11cy1lYXN0LTE.qYOHLToupROmvktinzGIi326HNroxy0uYoFMsa8uP2k\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:49.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895223,\n \"crawler\": \"NACIONALBNMP\",\n \ \ \"crawlerFullName\": \"Banco Nacional de Mandados de Pris\xC3\xA3o\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzVjM2ZmMTA0LTE3NTYtNGVhYi1hOTMwLTUyOGNjNTFiZDA2Ni8yNjJlZjRhOC1iZTQxLTQyOTktYjIxMC02OTZiYmU3OWVjZWUvP3JlZ2lvbj11cy1lYXN0LTE.Vuzv6SylsrqPQXSR0BYldOP-1EOB-fWo97jupNksTU0\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:18:27.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895224,\n \"crawler\": \"ALTJRG\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Alagoas (Busca por RG)\",\n \"isCertificate\"\ : false,\n \"status\": \"invalidInput\",\n \"linkEvidence\": null,\n \ \ \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\",\n \"ignored\": false,\n \ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n },\n\ \ {\n \"id\": 123895225,\n \"crawler\": \"BATJRG\",\n \"crawlerFullName\"\ : \"Tribunal de Justi\xC3\xA7a da Bahia (Busca por RG)\",\n \"isCertificate\": false,\n \ \ \"status\": \"invalidInput\",\n \"linkEvidence\": null,\n \"finishedProcessingAt\"\ : \"2021-07-07T11:14:50.000Z\",\n \"ignored\": false,\n \"review\": null,\n \ \ \"certificate\": null,\n \"trials\": []\n },\n {\n \"\ id\": 123895226,\n \"crawler\": \"ROJFTRF1\",\n \"crawlerFullName\": \"Justi\xC3\ \xA7a Federal do Rondonia Regional Federal da 1\xC2\xAA Regi\xC3\xA3o\",\n \"isCertificate\"\ : false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzIyMTZjMDNjLTgwYTYtNDA2ZS1iNWM0LWRmMmQ5MTk5YTRkYy9hODBiMWI5Yy1jMDNjLTQzZDQtOGIxNy05NDMwZTlmZGRiN2YvP3JlZ2lvbj11cy1lYXN0LTE.o5JyriDXSnwC17zAKB72bzwU0blbG4lch8V_r_dI5Ls\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:51.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895227,\n \"crawler\": \"MATJ\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Maranh\xC3\xA3o\",\n \"isCertificate\"\ : false,\n \"status\": \"processing\",\n \"linkEvidence\": null,\n \"\ finishedProcessingAt\": null,\n \"ignored\": true,\n \"review\": null,\n \ \ \"certificate\": null,\n \"trials\": []\n },\n {\n \"id\"\ : 123895228,\n \"crawler\": \"DFTJPJESI\",\n \"crawlerFullName\": \"Processo Juridico\ \ Eletronico do Distrito Federal (Segunda Instancia)\",\n \"isCertificate\": false,\n \ \ \"status\": \"processing\",\n \"linkEvidence\": null,\n \"finishedProcessingAt\"\ : null,\n \"ignored\": true,\n \"review\": null,\n \"certificate\": null,\n\ \ \"trials\": []\n },\n {\n \"id\": 123895229,\n \"\ crawler\": \"DFJFTRF1\",\n \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Distrito Federal\ \ Tribunal Regional Federal da 1\xC2\xAA Regi\xC3\xA3o\",\n \"isCertificate\": false,\n \ \ \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzg0MmNmM2FkLWJhNWQtNDUyNC1hMGUxLTMxN2U1NWYwNzk4Mi85Y2M3YWIzYy03ZjU1LTQ5YzgtYWEyMi1jYTVhMzBjNDFhMjkvP3JlZ2lvbj11cy1lYXN0LTE.md8U4eLYs9QwwV_pSQb4i0Fk8uFYf8-RoJ9nc7Fk_sE\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:47.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895230,\n \"crawler\": \"RNTJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Rio Grande do Norte (Busca por CPF)\",\n \ \ \"isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\"\ : \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzQzM2RmMGM5LTMyNjYtNDg2ZS04MWIxLTQ5NmJmNTkyN2NkMC8zNDE0OWZiMS1jYWJkLTQwMTctYWM2MS0yYjQyMDM3MWI3ZWUvP3JlZ2lvbj11cy1lYXN0LTE.RMBRLhMjCsrOhTyl07g-924gdDOp1TCRKjE36y_LBGs\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:50.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895231,\n \"crawler\": \"MAJFTRF1\",\n \ \ \"crawlerFullName\": \"Justi\xC3\xA7a Federal do Maranhao Tribunal Regional Federal da 1\xC2\xAA\ \ Regi\xC3\xA3o\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n \ \ \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzLzZkZWQwNWExLTZhY2ItNDU5MC1hN2FiLWQzY2IwZTkzODBmZi8yYjI4NjE3MC1lMTM4LTRiMTEtODM2ZC04NTM2YzFjOTUxYmEvP3JlZ2lvbj11cy1lYXN0LTE.eKKZTrDdl-hWYjSDS8DlNmGvvOIFC-oaP0PbrOjo2c0\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:45.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895232,\n \"crawler\": \"ROTJSICPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de Rond\xC3\xB4nia (Segunda Inst\xC3\xA2ncia\ \ - Busca por CPF)\",\n \"isCertificate\": false,\n \"status\": \"approved\",\n\ \ \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2I2ZWFjMzJlLTYzZDAtNDQyOC1iYTMyLTE3MjM2MDZjMmU4ZC8zNzk2MTlhNy00ZDQ2LTQ0NGItOWIwNi05NzJkMzY4MDBlMzYvP3JlZ2lvbj11cy1lYXN0LTE.wxXSzex-_OM100tsaov68KrvNeT55TSpGjDuo1pLdRs\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:20:38.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895233,\n \"crawler\": \"CETJCPF\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a do Cear\xC3\xA1 (Busca por CPF)\",\n \ \ \"isCertificate\": false,\n \"status\": \"approved\",\n \"linkEvidence\": \"\ crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2RmNWFmOWQxLWYzY2EtNGRkOC1hZTQ0LTU4MzQ1NWI4MWUwYi8xZGNkZmFhYi1hMmE5LTQ1MmQtYWViNi1hZjk3ODViZDg2MGMvP3JlZ2lvbj11cy1lYXN0LTE.nqz5qGb3AeGtnRDzNIkUp_yg0Ttrk0JtcJBXnExjLNI\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:56.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895234,\n \"crawler\": \"BATJPJE\",\n \ \ \"crawlerFullName\": \"Processo Juridico Eletronico da Bahia\",\n \"isCertificate\":\ \ false,\n \"status\": \"approved\",\n \"linkEvidence\": \"crawlers.bgcbrasil.com.br/evidences/eyJhbGciOiJIUzI1NiJ9.aHR0cHM6Ly9zMy5jb25zb2xlLmF3cy5hbWF6b24uY29tL3MzL2J1Y2tldHMvYmdjLWNyYXdsZXJzLXByb2R1Y3Rpb24tZXZpZGVuY2VzL2RmNzU0M2U1LTg1MWUtNGNhYy04NGIyLWIyZGNhOTViYTE5OS8wNDE0ZDdlZi0wNWU0LTRiYWQtOGUwMS1kZWNiNjY5MjY2OTkvP3JlZ2lvbj11cy1lYXN0LTE.yzxbgksPuoAKMI-ZmpPY1joaB_1Ph9b0IKrP4t18pg4\"\ ,\n \"finishedProcessingAt\": \"2021-07-07T11:17:53.000Z\",\n \"ignored\": false,\n\ \ \"review\": null,\n \"certificate\": null,\n \"trials\": []\n \ \ },\n {\n \"id\": 123895235,\n \"crawler\": \"BATJSIRG\",\n \ \ \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a da Bahia (Segunda Inst\xC3\xA2ncia - Busca por\ \ RG)\",\n \"isCertificate\": false,\n \"status\": \"invalidInput\",\n \ \ \"linkEvidence\": null,\n \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\",\n \ \ \"ignored\": false,\n \"review\": null,\n \"certificate\": null,\n \ \ \"trials\": []\n },\n {\n \"id\": 123895236,\n \"crawler\"\ : \"SPTJSIRG\",\n \"crawlerFullName\": \"Tribunal da Justi\xC3\xA7a de S\xC3\xA3o Paulo (Segunda\ \ inst\xC3\xA2ncia - Busca por RG)\",\n \"isCertificate\": false,\n \"status\":\ \ \"invalidInput\",\n \"linkEvidence\": null,\n \"finishedProcessingAt\": \"2021-07-07T11:14:50.000Z\"\ ,\n \"ignored\": false,\n \"review\": null,\n \"certificate\": null,\n\ \ \"trials\": []\n }\n ]\n }\n }\n },\n \"timestamp\": \"2020-11-24T22:42:12.209Z\"\ \n}" 'Full Check: Single Match Found': value: "{\n \"data\": {\n \"firstName\": \"JOHN\",\n \"firstSurname\": \"DOE\",\n \"secondSurname\"\ : \"DOE\",\n \"curp\": \"AAAA000000HCHLRN00\",\n \"dateOfBirth\": \"01/01/2000\",\n \"age\":\ \ 29,\n \"gender\": \"Male\",\n \"status\": \"Rejected\",\n \"stepExtra\": {\n \"query\"\ : {\n \"nombre\": \"JOHN\",\n \"paterno\": \"DOE\",\n \"materno\": \"DOE\",\n \ \ \"persona\": \"fisica\",\n \"curp\": \"AAAA000000HCHLRN00\",\n \"estado\": \"nacional\"\ ,\n \"fecha_inicio\": null,\n \"fecha_fin\": null,\n \"detalle\": true\n },\n\ \ \"numero_resultados\": 1,\n \"resultados\": [\n {\n \"entidad\": \"Chihuahua\"\ ,\n \"expedientes\": [\n {\n \"expediente\": \"01040/2016\",\n \ \ \"actor\": \"JOHN DOE\",\n \"demandado\": \"JOHN DOE\",\n \"entidad\"\ : \"Chihuahua\",\n \"juzgado\": \"Morelos - Juzgado Quinto Familiar por Audiencias\",\n \ \ \"tipo\": \" Juicio Ordinario Familiar Alimentos\",\n \"fuero\": \"Com\xFA\ n\",\n \"fecha\": \"14-09-2017\",\n \"acuerdos\": [\n {\n \ \ \"acuerdo\": \"JOHN DOE DID X \",\n \"fecha\": \"14-09-2017\"\n \ \ },\n {\n \"acuerdo\": \"JOHN DOE DID Y\",\n \ \ \"fecha\": \"22-09-2017\"\n },\n {\n \"acuerdo\":\ \ \"JOHN DOE DID Z\",\n \"fecha\": \"06-10-2017\"\n }\n ]\n\ \ }\n ]\n }\n ],\n \"homonimia\": \"1\",\n \"validacion_curp\"\ : {\n \"nombre\": \"JOHN\",\n \"paterno\": \"DOE\",\n \"materno\": \"DOE\",\n \ \ \"fecha_nacimiento\": \"01/01/2000\",\n \"sexo\": \"HOMBRE\",\n \"entidad_nacimiento\"\ : \"CHIHUAHUA\",\n \"curp\": \"AAAA000000HCHLRN00\"\n },\n \"cedula_profesional\": []\n\ \ }\n },\n \"error\": {\n \"type\": \"backgroundCheckError\",\n \"code\": \"backgroundMexicanBuholegal.SingleResultFound\"\ ,\n \"message\": \"The user was found to have criminal records, please review this user before accepting\ \ / rejecting\"\n }\n}" 'Full Check: Mutliple Matches Found': value: "{\n \"error\": {\n \"code\": \"background.ResultsFound\",\n \"message\": \"There were multiple\ \ matches with the information provided, and some of them have criminal records, please double check the\ \ user's information before accepting/rejecting\"\n },\n \"data\": {\n \"firstName\": \"JOHN\",\n\ \ \"curp\": \"AAAA000000HCHLRN00\",\n \"dateOfBirth\": \"2000-01-01\",\n \"age\": \"22\",\n \ \ \"gender\": \"Male\",\n \"status\": \"Rejected\",\n \"fullBackgroundCheck\": [\n {\n \ \ \"numero_resultados\": 1,\n \"resultados\": [\n {\n \"entidad\": \"\ Sonora\",\n \"expedientes\": [\n {\n \"expediente\": \"01801/2020\"\ ,\n \"actor\": \"JOHN DOE\",\n \"demandado\": \"JOHN DOE\",\n \ \ \"entidad\": \"Sonora\",\n \"juzgado\": \"Hermosillo - Juzgado Segundo de Primera\ \ Instancia Mercantil\",\n \"tipo\": \"\",\n \"fuero\": \"Com\xFAn\",\n\ \ \"fecha\": \"07-01-2021\",\n \"acuerdos\": [\n {\n \ \ \"acuerdo\": \"JOHN DOE DID X\",\n \"fecha\": \"07-01-2021\"\n \ \ },\n {\n \"acuerdo\": \"JOHN DOE DID Y\",\n \ \ \"fecha\": \"08-02-2021\"\n },\n {\n \ \ \"acuerdo\": \"JOHN DOE DID Z\",\n \"fecha\": \"10-02-2021\"\n \ \ }\n ]\n }\n ]\n }\n ],\n \"homonimia\"\ : 16,\n \"cedula_profesional\": \"[]\",\n \"query\": {\n \"nombre\": \"JOHN\",\n\ \ \"paterno\": \"DOE\",\n \"materno\": \"DOE\",\n \"persona\": \"fisica\",\n\ \ \"estado\": \"nacional\",\n \"fecha_inicio\": \"2019-01-01\",\n \"fecha_fin\"\ : \"2021-03-01\",\n \"detalle\": 1\n },\n \"validacion_curp.error\": \"El CURP\ \ no pudo ser validado. Hubo un error de conexion con el Registro Nacional de Poblaci\xF3n.\"\n }\n\ \ ]\n },\n \"timestamp\": \"2020-11-24T22:42:12.209Z\"\n}" schema: oneOf: - title: 'Full Check: No Criminal Records Found' type: object properties: error: {} data: type: object properties: fullName: type: string example: JOHN DOE cpf: type: string example: '00000000000' dateOfBirth: type: string example: '1980-01-01' status: type: string example: Accepted fullBackgroundCheck: type: object properties: search: type: object properties: id: type: string example: ffffffff-ffff-ffff-ffff-ffffffffffff tags: type: object properties: identityId: type: string example: ffffffff-ffff-ffff-ffff-ffffffffffff BranchId: type: integer example: 278 default: 0 isStatusTemporary: type: boolean example: true default: true status: type: string example: preApproved createdAt: type: string example: '2021-07-07T11:14:48.342Z' receivedNotifiableStatusAt: type: string example: '2021-07-07T11:20:59.956Z' finishedProcessingAt: {} priorityFinishedProcessingAt: type: string example: '2021-07-07T11:20:59.956Z' exceptionListStatus: {} notifiedWebhookAt: {} officialNameStatus: type: string example: match candidate: type: object properties: officialName: type: string example: JOHN DOE name: type: string example: JOHN DOE cpf: type: string example: '00000000000' birthday: type: string example: '1980-01-01' receivedFinalStatusAt: type: string example: '2021-07-07T11:20:59.956Z' results: type: array items: type: object properties: id: type: integer example: 123895176 default: 0 crawler: type: string example: ACTJRG crawlerFullName: type: string example: "Tribunal da Justi\xC3\xA7a do Acre (Busca por RG)" isCertificate: type: boolean example: false default: true status: type: string example: invalidInput linkEvidence: {} finishedProcessingAt: type: string example: '2021-07-07T11:14:50.000Z' ignored: type: boolean example: false default: true review: {} certificate: {} trials: type: array items: type: object properties: {} timestamp: type: string example: '2020-11-24T22:42:12.209Z' - title: 'Full Check: Single Match Found' type: object properties: data: type: object properties: firstName: type: string example: JOHN firstSurname: type: string example: DOE secondSurname: type: string example: DOE curp: type: string example: AAAA000000HCHLRN00 dateOfBirth: type: string example: 01/01/2000 age: type: integer example: 29 default: 0 gender: type: string example: Male status: type: string example: Rejected stepExtra: type: object properties: query: type: object properties: nombre: type: string example: JOHN paterno: type: string example: DOE materno: type: string example: DOE persona: type: string example: fisica curp: type: string example: AAAA000000HCHLRN00 estado: type: string example: nacional fecha_inicio: {} fecha_fin: {} detalle: type: boolean example: true default: true numero_resultados: type: integer example: 1 default: 0 resultados: type: array items: type: object properties: entidad: type: string example: Chihuahua expedientes: type: array items: type: object properties: expediente: type: string example: 01040/2016 actor: type: string example: JOHN DOE demandado: type: string example: JOHN DOE entidad: type: string example: Chihuahua juzgado: type: string example: Morelos - Juzgado Quinto Familiar por Audiencias tipo: type: string example: ' Juicio Ordinario Familiar Alimentos' fuero: type: string example: "Com\xFAn" fecha: type: string example: 14-09-2017 acuerdos: type: array items: type: object properties: acuerdo: type: string example: 'JOHN DOE DID X ' fecha: type: string example: 14-09-2017 homonimia: type: string example: '1' validacion_curp: type: object properties: nombre: type: string example: JOHN paterno: type: string example: DOE materno: type: string example: DOE fecha_nacimiento: type: string example: 01/01/2000 sexo: type: string example: HOMBRE entidad_nacimiento: type: string example: CHIHUAHUA curp: type: string example: AAAA000000HCHLRN00 cedula_profesional: type: array items: type: object properties: {} error: type: object properties: type: type: string example: backgroundCheckError code: type: string example: backgroundMexicanBuholegal.SingleResultFound message: type: string example: The user was found to have criminal records, please review this user before accepting / rejecting - title: 'Full Check: Mutliple Matches Found' type: object properties: error: type: object properties: code: type: string example: background.ResultsFound message: type: string example: There were multiple matches with the information provided, and some of them have criminal records, please double check the user's information before accepting/rejecting data: type: object properties: firstName: type: string example: JOHN curp: type: string example: AAAA000000HCHLRN00 dateOfBirth: type: string example: '2000-01-01' age: type: string example: '22' gender: type: string example: Male status: type: string example: Rejected fullBackgroundCheck: type: array items: type: object properties: numero_resultados: type: integer example: 1 default: 0 resultados: type: array items: type: object properties: entidad: type: string example: Sonora expedientes: type: array items: type: object properties: expediente: type: string example: 01801/2020 actor: type: string example: JOHN DOE demandado: type: string example: JOHN DOE entidad: type: string example: Sonora juzgado: type: string example: Hermosillo - Juzgado Segundo de Primera Instancia Mercantil tipo: type: string example: '' fuero: type: string example: "Com\xFAn" fecha: type: string example: 07-01-2021 acuerdos: type: array items: type: object properties: acuerdo: type: string example: JOHN DOE DID X fecha: type: string example: 07-01-2021 homonimia: type: integer example: 16 default: 0 cedula_profesional: type: string example: '[]' query: type: object properties: nombre: type: string example: JOHN paterno: type: string example: DOE materno: type: string example: DOE persona: type: string example: fisica estado: type: string example: nacional fecha_inicio: type: string example: '2019-01-01' fecha_fin: type: string example: '2021-03-01' detalle: type: integer example: 1 default: 0 validacion_curp.error: type: string example: "El CURP no pudo ser validado. Hubo un error de conexion con el Registro Nacional\ \ de Poblaci\xF3n." timestamp: type: string example: '2020-11-24T22:42:12.209Z' '503': description: '503' content: application/json: examples: Result: value: "{\n \"error\": {\n \"code\": \"system.serviceUnavailable\",\n \"message\": \"The Background\ \ Check service is currently unavailable, please try again later\"\n },\n \"data\": null,\n \"timestamp\"\ : \"2020-11-24T22:42:12.209Z\"\n}" schema: type: object properties: error: type: object properties: code: type: string example: system.serviceUnavailable message: type: string example: The Background Check service is currently unavailable, please try again later data: {} timestamp: type: string example: '2020-11-24T22:42:12.209Z' deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.prod.metamap.com/backgroundchecks/v1/br/background \\ \n--header\ \ 'Content-Type: application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n \"fullName\"\ : \"JOHN DOE\",\n \"cpf\": \"1234567890\",\n \"dateOfBirth\": \"1990-01-01\", \n \"fullCheck\": true\n}'" samples-languages: - curl tags: - Background Checks /creditchecks/v1/br/credit-serasa: post: summary: Brazil Credit Check description: Review a user's credit score against Brazil's Serasa operationId: brazil-credit-check parameters: - name: Content-Type in: header schema: type: string - name: Accept in: header schema: type: string responses: '202': description: '202' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '422': description: '422' content: application/json: examples: Result: value: "{\n \"name\": \"\",\n \"message\": \"\",\n \"code\": 0,\n \"type\": \"\"\ \n}" schema: type: object properties: name: type: string example: message: type: string example: code: type: integer example: 0 default: 0 type: type: string example: deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.getmati.com/creditchecks/v1/ar/credit-fidelitas \\\n --header\ \ 'accept: application/json' \\\n --header 'content-type: application/json'" name: cURL REQUEST samples-languages: - curl tags: - Credit Checks /safety/v1/checks/comply-advantage: post: summary: Comply Advantage description: Use this check to verify whether a user or company is listed on international watchlists. operationId: comply-advantage requestBody: content: application/json: schema: type: object required: - name properties: entityType: type: string description: Choose between `person` or `company`. default: person name: type: string description: User's full name or company's name birthYear: type: integer description: Applicable to 'person', only. User's year of birth. format: int32 monitor: type: boolean description: Set to true if you want the search to be monitored regularly. default: false callbackUrl: type: string description: Callback URL for monitoring updates through webhooks. Mandatory if monitor = true. countryCodes: type: array description: An array of 2-letter country codes as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). items: type: string exactMatch: type: boolean description: Specify that results must match all specified parameters. default: false fuzzinessThreshold: type: integer description: Integer in range of 0-100 specifying how closely matched results must be to the specified parameters. default: 50 format: int32 metadata: type: string description: Use the `metadata` parameter to add internal references. default: '{ "user-defined-1" : "abcde", "user-defined-2" : "12345" }' format: json responses: '200': description: '200' content: application/json: examples: Person Not Found: value: "{\n \"data\": {\n \"searchedOn\": \"2020-05-13 09:26:50\",\n \"nameSearched\": \"JOHN DOE\"\ ,\n \"profileUrl\": \"https://public.url\",\n \"error\": null\n }\n}" Person Found on Watchlist: value: "{\n \"searchedOn\": \"2022-03-01 00:00:00\",\n \"nameSearched\": \"JOHN DOE\",\n \"profileUrl\"\ : \"https://app.complyadvantage.com/public/search/1234567890-abcdef1g/123456789012\",\n \"searchId\"\ : 000000000,\n \"error\": {\n \"type\": \"SafetyCheckError\",\n \"code\": \"premiumAmlWatchlists.matchFound\"\ ,\n \"details\": {\n \"matchStatus\": \"potential_match\",\n \"riskLevel\"\ : \"unknown\"\n }\n }" schema: type: object properties: data: type: object properties: searchedOn: type: string example: '2020-05-13 09:26:50' nameSearched: type: string example: JOHN DOE profileUrl: type: string example: https://public.url error: {} text/plain: examples: Company Not Found: value: "{\n \"searchedOn\": \"2022-03-01 00:00:00\",\n \"nameSearched\": \"ACME INC\",\n \"profileUrl\"\ : \"https://app.complyadvantage.com/public/search/1234567890-abcdef1g/123456789012\",\n \"searchId\"\ : 000000000\n}" deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/safety/v1/checks/comply-advantage' \\\n--header 'Authorization:\ \ Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"entityType\":\ \ \"person\",\n \"name\": \"JOHN DOE\",\n \"birthYear\": 1970,\n \"countryCodes\": ['US', 'FR', 'DE'],\n\ \ \"metadata\": {\n \"user-defined-1\" : \"abcde\", \n \"user-defined-2\" : \"12345\" \n }\n}'" name: Person Search Without Monitoring - language: curl code: "curl --location --request POST 'https://api.getmati.com/safety/v1/checks/comply-advantage' \\\n--header 'Authorization:\ \ Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"entityType\":\ \ \"person\",\n \"name\": \"JOHN DOE\",\n \"birthYear\": 1970,\n \"monitor\": true, \n \"callbackUrl\"\ : \"https://some.webhook.url\"\n}'" name: Person Search With Monitoring - language: curl code: "curl --location --request POST 'https://api.getmati.com/safety/v1/checks/comply-advantage' \\\n--header 'Authorization:\ \ Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"entityType\":\ \ \"company\",\n \"name\": \"ACME INC\",\n \"countryCodes\": ['US', 'AR', 'BR']\n}'" name: Company Search Without Monitoring - language: curl code: "curl --location --request POST 'https://api.getmati.com/safety/v1/checks/comply-advantage' \\\n--header 'Authorization:\ \ Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw {\n \"entityType\": \"\ company\", \n \"name\": \"ACME INC\",\n \"monitor\": \"true\",\n \"callbackUrl\": \"https://some.webhook.url\"\ \n}" name: Company Search With Monitoring - language: curl code: "curl --location --request POST 'https://api.getmati.com/safety/v1/checks/comply-advantage' \\\n--header 'Authorization:\ \ Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"JOHN\ \ DOE\",\n \"fuzzinessThreshold\": 50\n}'" name: Person Search with Fuzziness Threshold = 50 - language: curl code: "curl --location --request POST 'https://api.getmati.com/safety/v1/checks/comply-advantage' \\\n--header 'Authorization:\ \ Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"name\": \"JOHN\ \ DOE\",\n \"exactMatch\": true\n}'" name: Person Search with Exact Match = true samples-languages: - curl tags: - Watchlist Checks /verifications/{verificationId}: delete: summary: Delete Verification description: '' operationId: delete-verification parameters: - name: verificationId in: path description: Unique string assigned to a user's verification status schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Success: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Invalid status movement: value: '{}' schema: type: object properties: {} '404': description: '404' content: text/plain: examples: Verification not found: value: '{}' schema: type: object properties: {} '500': description: '500' content: text/plain: examples: Unexpected error: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: "curl --request DELETE \\\n --url 'https://api.prod.metamap.com/verifications/{verificationId}' \\\n \ \ --header 'Authorization: Bearer '\n" samples-languages: - curl tags: - Verifications /verification/v1/pdf/download: post: summary: Download Verification Results description: Use this API to download verification results in a PDF file. operationId: download-verifications requestBody: content: application/json: schema: type: object required: - request_id - verification_ids - timezone properties: request_id: type: string description: String to be associated with the PDF request. We will pass this string with the callback. verification_ids: type: array description: Verification numbers identifying the verifications to be downloaded. items: type: string timezone: type: string description: Your timezone. default: Australia/Darwin callback_details: type: object properties: {} metadata: type: string description: Additional data you need returned as part of the callback. format: json responses: '200': description: '200' content: application/json: examples: All IDs Found: value: "{\n \"status\": \"SUCCESS\",\n \"acceptedVerificationIds\": [\n \"000aaaaaaa00a0000aa0aa00\"\ \n ],\n \"rejectedVerificationIds\": []\n}" One Or More IDs Rejected: value: "{\n \"status\": \"FAILURE\",\n \"acceptedVerificationIds\": [],\n \"rejectedVerificationIds\"\ : [\n \"000aaaaaaa00a0000aa0aa00\"\n ]\n}" schema: oneOf: - title: All IDs Found type: object properties: status: type: string example: SUCCESS acceptedVerificationIds: type: array items: type: string example: 000aaaaaaa00a0000aa0aa00 rejectedVerificationIds: type: array items: type: object properties: {} - title: One Or More IDs Rejected type: object properties: status: type: string example: FAILURE acceptedVerificationIds: type: array items: type: object properties: {} rejectedVerificationIds: type: array items: type: string example: 000aaaaaaa00a0000aa0aa00 '400': description: '400' content: text/plain: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/verification/v1/pdf/download' \\\n--header 'Authorization:\ \ Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"request_id\": \"\ \",\n \"verification_ids\": [\"\",\"\",\"\",],\n \"callback_details\": {\n \"url\": \"\",\n \"headers\": {\n \ \ \"api_key\": \"\",\n \"content-type\": \"multipart/form-data\"\n }\n \ \ }\n}'" name: REQUEST samples-languages: - curl tags: - Verifications servers: - url: https://api.getmati.com /safety/v1/checks/email/otp: post: summary: Email Ownership description: This API sends an OTP to the email address to verify user ownership operationId: email-ownership requestBody: content: application/json: schema: type: object required: - callbackURL - recipient properties: callbackURL: type: string locale: type: string description: 'Language and country codes: for example, "en_US" for English and United States.' default: en_US recipient: type: string description: User's email address senderName: type: string description: User's name senderEmail: type: string description: Address that sends the email metadata: type: string description: Metadata to be sent to a webhook (callbackUrl) default: '{ "user-defined-1" : "abcde", "user-defined-2" : "12345" }' format: json responses: '200': description: '200' content: application/json: examples: Result: value: "{\n\t\"error\": null,\n \"data\": {\n \t\"confirmationCode\": \"0301\"\n },\n \"metadata\":\ \ {\n \t\"user_defined\": \"id00000\"\n }\n}" schema: type: object properties: error: {} data: type: object properties: confirmationCode: type: string example: '0301' metadata: type: object properties: user_defined: type: string example: id00000 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: "POST https://api.getmati.com/safety/v1/checks/email/otp \n-H 'Content-Type: application/json' \\\n-H \"Authorization:\ \ Bearer \" \\\n{\n\t\"recipient\": \"example@mati.io\",\n \"callbackUrl\": \"https://some.webhook.url\"\ ,\n \"locale\": \"es_MX\",\n \"senderEmail\": \"some@doman.com\",\n \"senderName\": \"Acme Company\",\n \"\ metadata\": { \n \t\"user_defined\": \"id00000\n }\n}" samples-languages: - curl tags: - Email Checks /safety/v1/checks/email/risk: post: summary: Email Risk description: This API provides a behavioral risk assessment based on email address operationId: email-risk requestBody: content: application/json: schema: type: object required: - recipient - callbackUrl properties: recipient: type: string description: User's email address callbackUrl: type: string description: Webhook URL to receive risk assessment information. metadata: type: string description: Metadata to be sent to a webhook (callbackUrl) default: '{ "user-defined-1" : "abcde", "user-defined-2" : "12345" }' format: json responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"error\": null,\n \"data\": {\n \"email\": \"example@mati.io\",\n \"riskScore\": 0,\n\ \ \"message\": \"Success.\",\n \"success\": true,\n \"valid\": true,\n \"disposable\": false,\n\ \ \"smtp_score\": 2,\n \"overall_score\": 3,\n \"first_name\": \"Corporate\",\n \"generic\"\ : true,\n \"common\": false,\n \"dns_valid\": true,\n \"honeypot\": false,\n \"deliverability\"\ : \"medium\",\n \"frequent_complainer\": false,\n \"spam_trap_score\": \"none\",\n \"catch_all\"\ : true,\n \"timed_out\": false,\n \"suspect\": true,\n \"recent_abuse\": false,\n \"suggested_domain\"\ : \"N/A\",\n \"leaked\": false,\n \"domain_age\": {\n \"human\": \"7 years ago\",\n \"\ timestamp\": 1439710398,\n \"iso\": \"2015-08-16T03:33:18-04:00\"\n },\n \"first_seen\": {\n\ \ \"human\": \"4 minutes ago\",\n \"timestamp\": 1650250506,\n \"iso\": \"2022-04-17T22:55:06-04:00\"\ \n },\n \"sanitized_email\": \"example@mati.io\",\n \"domain_velocity\": \"Enterprise Mini or\ \ higher required.\",\n \"user_activity\": \"Enterprise L4+ required.\",\n \"request_id\": \"3Ab9vwBZsY\"\ \n },\n \"metadata\": {\n \t\"user_defined\": \"id00000\"\n }\n}" schema: type: object properties: error: {} data: type: object properties: email: type: string example: example@mati.io riskScore: type: integer example: 0 default: 0 message: type: string example: Success. success: type: boolean example: true default: true valid: type: boolean example: true default: true disposable: type: boolean example: false default: true smtp_score: type: integer example: 2 default: 0 overall_score: type: integer example: 3 default: 0 first_name: type: string example: Corporate generic: type: boolean example: true default: true common: type: boolean example: false default: true dns_valid: type: boolean example: true default: true honeypot: type: boolean example: false default: true deliverability: type: string example: medium frequent_complainer: type: boolean example: false default: true spam_trap_score: type: string example: none catch_all: type: boolean example: true default: true timed_out: type: boolean example: false default: true suspect: type: boolean example: true default: true recent_abuse: type: boolean example: false default: true suggested_domain: type: string example: N/A leaked: type: boolean example: false default: true domain_age: type: object properties: human: type: string example: 7 years ago timestamp: type: integer example: 1439710398 default: 0 iso: type: string example: '2015-08-16T03:33:18-04:00' first_seen: type: object properties: human: type: string example: 4 minutes ago timestamp: type: integer example: 1650250506 default: 0 iso: type: string example: '2022-04-17T22:55:06-04:00' sanitized_email: type: string example: example@mati.io domain_velocity: type: string example: Enterprise Mini or higher required. user_activity: type: string example: Enterprise L4+ required. request_id: type: string example: 3Ab9vwBZsY metadata: type: object properties: user_defined: type: string example: id00000 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/safety/v1/checks/email/risk' \\\n--header 'Authorization:\ \ Bearer \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\t\"recipient\": \"example@mati.io\"\ ,\n\t\"callbackUrl\": \"https://some.webhook.url\",\n\t\"metadata\": {\t\"user_defined\": \"id00000\" }\n}'" name: Example Request samples-languages: - curl tags: - Email Checks /file: get: summary: Get Verification Media description: Use this API to download user documents, photos, and videos. operationId: get-verification-media parameters: - name: media_auth in: path description: The `media_auth` is part of the path returned when a Retrieve Webhook Resource call succeeds. schema: type: string required: true responses: '400': description: '400' content: application/json: examples: Bad URL: value: "{\n \"code\": 400,\n \"data\": {},\n \"message\": \"Media URL malformed\",\n \"name\"\ : \"MoleculerError\",\n \"type\": \"MEDIA_API_ERROR\"\n}" schema: type: object properties: code: type: integer example: 400 default: 0 data: type: object properties: {} message: type: string example: Media URL malformed name: type: string example: MoleculerError type: type: string example: MEDIA_API_ERROR deprecated: false x-readme: code-samples: - language: curl code: 'curl --location --request GET ''https://media.getmati.com/file?location={media_auth}'' \ --header ''Authorization: Bearer ''' name: Get Media Example samples-languages: - curl tags: - Verifications servers: - url: https://media.prod.metamap.com /govchecks/v1/gh/verify-card-facematch: post: summary: 'GovCheck: Ghana Verify Card (Facematch)' description: "Validates national identity information and performs biometric face verification against the government\u2019\ s biometric database." operationId: govcheck-ghana-verify-card-facematch parameters: - name: Content-Type in: header schema: type: string default: application/json requestBody: content: application/json: schema: type: object required: - personalNumber - imageBase64 - callbackUrl properties: personalNumber: type: string imageBase64: type: string callbackUrl: type: string metadata: type: string description: '{"key":"value"}' format: json responses: '202': description: '202' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '422': description: '422' content: application/json: examples: Result: value: "{\n \"name\": \"ValidationError\",\n \"message\": \"Parameters validation error!\",\n \"\ code\": 422,\n \"type\": \"VALIDATION_ERROR\",\n \"data\": [\n {\n \"keyword\"\ : \"required\",\n \"dataPath\": \"\",\n \"schemaPath\": \"#/required\",\n \ \ \"params\": {\n \"missingProperty\": \"documentNumber\"\n },\n \ \ \"message\": \"should have required property 'documentNumber'\",\n \"nodeID\": \"safety-85b9845fc5-fgznw-1\"\ ,\n \"action\": \"govChecks.getpanamaTseFacematch\"\n }\n ]\n}" VALIDATION ERRROR imageBase64: value: "{\n \"name\": \"ValidationError\",\n \"message\": \"Parameters validation error!\",\n \"\ code\": 422,\n \"type\": \"VALIDATION_ERROR\",\n \"data\": [\n {\n \"keyword\"\ : \"required\",\n \"dataPath\": \"\",\n \"schemaPath\": \"#/required\",\n \ \ \"params\": {\n \"missingProperty\": \"selfie\"\n },\n \"\ message\": \"should have required property 'selfie'\",\n \"nodeID\": \"safety-7f546fd8b8-crsr8-1\"\ ,\n \"action\": \"govChecks.getPanamaTseFacematch\"\n }\n ]\n}" schema: oneOf: - type: object properties: name: type: string example: ValidationError message: type: string example: Parameters validation error! code: type: integer example: 422 default: 0 type: type: string example: VALIDATION_ERROR data: type: array items: type: object properties: keyword: type: string example: required dataPath: type: string example: '' schemaPath: type: string example: '#/required' params: type: object properties: missingProperty: type: string example: documentNumber message: type: string example: should have required property 'documentNumber' nodeID: type: string example: safety-85b9845fc5-fgznw-1 action: type: string example: govChecks.getpanamaTseFacematch - title: VALIDATION ERRROR imageBase64 type: object properties: name: type: string example: ValidationError message: type: string example: Parameters validation error! code: type: integer example: 422 default: 0 type: type: string example: VALIDATION_ERROR data: type: array items: type: object properties: keyword: type: string example: required dataPath: type: string example: '' schemaPath: type: string example: '#/required' params: type: object properties: missingProperty: type: string example: selfie message: type: string example: should have required property 'selfie' nodeID: type: string example: safety-7f546fd8b8-crsr8-1 action: type: string example: govChecks.getPanamaTseFacematch deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.prod.metamap.com/govchecks/v1/gh/verify-card-facematch \\\n\ \ --header 'Content-Type: application/json' \\\n --header 'accept: application/json' \\\n --header\ \ 'authorization: Bearer token' \\\n --data '\n{\n \"personalNumber\": \"GH-000000000-0\",\n \"imageBase64\"\ : \"iVBORw0KGgoAAAANSUhEU...\",\n \"callbackUrl\": \"https://yourdomain.com/webhook-listener\",\n \"metadata\"\ : \"{\"key\":\"value\"}\"\n}\n'" samples-languages: - curl tags: - GovChecks /govchecks/v1/gh/verify-card: post: summary: 'GovCheck: Ghana Verify Card' description: "Validates national identity information by checking against Ghana\u2019s National Identification Authority\ \ (NIA) database for the Ghana Card." operationId: govcheck-ghana-verify-card parameters: - name: Content-Type in: header schema: type: string default: application/json requestBody: content: application/json: schema: type: object required: - personalNumber - callbackUrl properties: personalNumber: type: string callbackUrl: type: string metadata: type: string description: '{"key":"value"}' format: json responses: '202': description: '202' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '422': description: '422' content: application/json: examples: Result: value: "{\n \"name\": \"ValidationError\",\n \"message\": \"Parameters validation error!\",\n \"\ code\": 422,\n \"type\": \"VALIDATION_ERROR\",\n \"data\": [\n {\n \"keyword\"\ : \"required\",\n \"dataPath\": \"\",\n \"schemaPath\": \"#/required\",\n \ \ \"params\": {\n \"missingProperty\": \"personalNumber\"\n },\n \ \ \"message\": \"should have required property 'personalNumber'\",\n \"nodeID\": \"safety-7f5400d8b8-df9f8-1\"\ ,\n \"action\": \"govChecks.getGhanaianVerifyCard\"\n }\n ]\n}" schema: type: object properties: name: type: string example: ValidationError message: type: string example: Parameters validation error! code: type: integer example: 422 default: 0 type: type: string example: VALIDATION_ERROR data: type: array items: type: object properties: keyword: type: string example: required dataPath: type: string example: '' schemaPath: type: string example: '#/required' params: type: object properties: missingProperty: type: string example: personalNumber message: type: string example: should have required property 'personalNumber' nodeID: type: string example: safety-7f5400d8b8-df9f8-1 action: type: string example: govChecks.getGhanaianVerifyCard deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.prod.metamap.com/govchecks/v1/gh/verify-card \\\n --header\ \ 'Content-Type: application/json' \\\n --header 'accept: application/json' \\\n --header 'authorization:\ \ Bearer 1' \\\n --data '\n{\n \"personalNumber\": \"GH-00000000-0\",\n \"callbackUrl\": \"https://yourdomain.com/webhook-listener\"\ ,\n \"metadata\": \"{\"key\":\"value\"}\"\n}\n'" samples-languages: - curl tags: - GovChecks /govchecks/v1/mx/pep: post: summary: 'GovChecks: Mexico PEP' description: Check whether a user is a Politically Exposed Person operationId: govcheck-mexico-pep requestBody: content: application/json: schema: type: object required: - callbackUrl - fullName properties: callbackUrl: type: string description: Webhook URL fullName: type: string responses: '200': description: '200' content: application/json: examples: User is Not a Politically Exposed Person: value: "{\n \"error\": null,\n \"data\": {\n \"pep\": false,\n \"country\": \"MX\",\n \"fullName\"\ : \"Jose Antonio Saavedra Hernandez\",\n \"PEPdata\": null\n }\n}" schema: type: object properties: error: {} data: type: object properties: pep: type: boolean example: false default: true country: type: string example: MX fullName: type: string example: Jose Antonio Saavedra Hernandez PEPdata: {} '202': description: '202' content: application/json: examples: User is a Politically Exposed Person: value: "{\n\"error\": {\n \"type\":\"legacy.error\",\n \"code\":\"mxPepError.matchFound\",\n \"message\"\ :\"The user was found to be a PEP\"\n },\n \"data\": {\n \"pep\": true,\n \"country\": \"MX\",\n \ \ \"fullName\": \"Jose Antonio Saavedra Hernandez\",\n \"PEPdata\": \n [{\n \"PEPfullName\":\ \ \"Jose Antonio Saavedra Hernandez\",\n \"state\":\"Tamaulipas\",\n \"institution\": \"Sistema\ \ para el Desarrollo Integral de la Familia del Municipio de Victoria.\",\n \"position\": \"AUXILIAR\ \ DE PROGRAMA\",\n \"period\":\"01/10/2020 - 31/12/2020\"\n }\n ]\n }\n}" schema: type: object properties: error: type: object properties: type: type: string example: legacy.error code: type: string example: mxPepError.matchFound message: type: string example: The user was found to be a PEP data: type: object properties: pep: type: boolean example: true default: true country: type: string example: MX fullName: type: string example: Jose Antonio Saavedra Hernandez PEPdata: type: array items: type: object properties: PEPfullName: type: string example: Jose Antonio Saavedra Hernandez state: type: string example: Tamaulipas institution: type: string example: Sistema para el Desarrollo Integral de la Familia del Municipio de Victoria. position: type: string example: AUXILIAR DE PROGRAMA period: type: string example: 01/10/2020 - 31/12/2020 '503': description: '503' content: application/json: examples: Service is Unavailable: value: "{\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"system.serviceUnavailable\"\ ,\n \"message\": \"The PEP Service is unavailable\"\n },\n \"data\": null\n }\n}" deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.getmati.com/govchecks/v1/mx/pep \\\n --header 'Accept:\ \ application/json'\n --data-raw '{\n \t\t\"fullName\": \"JOHN JAY DOE\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/mx/rfc: post: summary: 'GovChecks: Mexico RFC' description: Validate CURP and RFC numbers to validate users are eligible to pay taxes operationId: govcheck-mexico-rfc requestBody: content: application/json: schema: type: object required: - callbackUrl - CURP properties: callbackUrl: type: string description: Webhook URL CURP: type: string description: User's CURP or RFC number responses: '200': description: '200' content: application/json: examples: Registered taxpayer: value: "{\n \"error\": null,\n \"data\": {\n \"curp\": \"AAAA000000HCHLRN00\",\n \"registeredTaxPayer\"\ : true\n }\n}" schema: type: object properties: error: {} data: type: object properties: curp: type: string example: AAAA000000HCHLRN00 registeredTaxPayer: type: boolean example: true default: true deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.getmati.com/govchecks/v1/mx/rfc \\\n --header 'Accept:\ \ application/json' \\\n --data-raw {\n \"curp\": \"AAAA000000HCHLRN00\",\n \"callbackUrl\": \"https://some.webhook.url\"\ \n }\n " samples-languages: - curl tags: - GovChecks /govchecks/v1/py/rcp: post: summary: 'GovCheck: Paraguay RCP' description: "Validates national identity information by checking against Paraguay\u2019s RCP database for the C\xE9\ dula de Identidad Civil." operationId: govcheck-paraguay-rcp requestBody: content: application/json: schema: type: object required: - documentNumber - dateOfBirth - callbackUrl properties: documentNumber: type: string dateOfBirth: type: string description: DD/MM/YYYY callbackUrl: type: string metadata: type: string description: '{"key":"value"}' format: json responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.prod.metamap.com/govchecks/v1/py/rcp \\\n --header 'Content-Type:\ \ application/json' \\\n --header 'accept: application/json' \\\n --header 'authorization: Bearer 1' \\\ \n --data '\n{\n \"documentNumber\": \"0000000\",\n \"dateOfBirth\": \"31/01/1999\",\n \"callbackUrl\"\ : \"https://yourdomain.com/webhook-listener\",\n \"metadata\": {\"key\":\"value\"}\n}\n'" samples-languages: - curl tags: - GovChecks /govchecks/v1/br/cnpj-extended: post: summary: 'GovChecks: Brazil CNPJ Extended Validation' description: Validate a business's National Registry of Legal Entities number operationId: govchecks-brazil-cnpj-extended-validation requestBody: content: application/json: schema: type: object required: - cnpj - callbackURL properties: cnpj: type: string callbackURL: type: string responses: '200': description: '200' content: application/json: examples: Valid and Active CNPJ: value: "{\n \"error\": null,\n \"data\": {\n \"registrationNumber\": \"00000000000000\",\n \ \ \"tipoEstabelecimento\": \"1\",\n \"companyName\": \"METAMAP\",\n \"legalName\": \"METAMAP\"\ ,\n \"cadastralStatus\": {\n \"registrationStatus\": \"2\",\n \"statusDate\": \"2016-01-01\"\ ,\n \"reason\": \"\"\n },\n \"legalNature\": {\n \"legalCode\": \"2054\",\n \ \ \"legalDescription\": \"Sociedade An\xF4nima Fechada\"\n },\n \"registrationDate\": \"\ 2016-01-01\",\n \"cnaePrincipal\": {\n \"cnaeCode\": \"4751201\",\n \"cnaeDescription\"\ : \"Com\xE9rcio varejista especializado de equipamentos e suprimentos de inform\xE1tica\"\n },\n\ \ \"address\": {\n \"street\": \"RUA\",\n \"locality\": \"CARLOS GOMES\",\n \ \ \"areaNumber\": \"1234\",\n \"additionalAddress\": \"ANDAR 10A 10\",\n \"postcode\": \"\ 80013\",\n \"localitySector\": \"CENTRO\",\n \"federationUnit\": \"SP\",\n \"country\"\ : {\n \"code\": \"105\",\n \"description\": \"BRASIL\"\n },\n \"county\"\ : {\n \"administrativeCode\": \"6639\",\n \"administrativeName\": \"LIMEIRA\"\n \ \ }\n },\n \"municipalitiesJurisdiction\": {\n \"code\": \"0811200\",\n \"\ description\": \"LIMEIRA\"\n },\n \"phones\": [\n {\n \"phoneCode\": \"19\"\ ,\n \"phoneNumber\": \"21138250\"\n }\n ],\n \"email\": \"welcome@metamap.com\"\ ,\n \"capitalSocial\": 77766517900,\n \"companySize\": \"05\",\n \"situacaoEspecial\":\ \ \"\",\n \"dataSituacaoEspecial\": \"\",\n \"informacoesAdicionais\": {\n \"optanteSimples\"\ : \"N\xC3O\",\n \"optanteMei\": \"N\xC3O\",\n \"listaPeriodosSimples\": []\n },\n \ \ \"shareholdersInfo\": [\n {\n \"shareholderType\": \"2\",\n \"cpfNumber\"\ : \"00000000000\",\n \"shareholderName\": \"FILIP VICTOR\",\n \"qualificacao\": \"10\"\ ,\n \"assignationDate\": \"2022-07-06\",\n \"country\": {\n \"code\": \"\ 105\",\n \"description\": \"BRASIL\"\n },\n \"legalRepresentation\": {\n\ \ \"representativeCpf\": \"00000000000\",\n \"representativeName\": \"\",\n \ \ \"qualificacao\": \"00\"\n }\n },\n {\n \"shareholderType\":\ \ \"2\",\n \"cpfNumber\": \"00000000000\",\n \"shareholderName\": \"MEGHNA MANN\", \n\ \ \"qualificacao\": \"10\",\n \"assignationDate\": \"2022-07-06\",\n \"country\"\ : {\n \"code\": \"105\",\n \"description\": \"BRASIL\"\n },\n \ \ \"legalRepresentation\": {\n \"representativeCpf\": \"00000000000\",\n \"representativeName\"\ : \"\",\n \"qualificacao\": \"00\"\n }\n }\n ]\n }\n}" schema: type: object properties: error: {} data: type: object properties: registrationNumber: type: string example: '00000000000000' tipoEstabelecimento: type: string example: '1' companyName: type: string example: METAMAP legalName: type: string example: METAMAP cadastralStatus: type: object properties: registrationStatus: type: string example: '2' statusDate: type: string example: '2016-01-01' reason: type: string example: '' legalNature: type: object properties: legalCode: type: string example: '2054' legalDescription: type: string example: "Sociedade An\xF4nima Fechada" registrationDate: type: string example: '2016-01-01' cnaePrincipal: type: object properties: cnaeCode: type: string example: '4751201' cnaeDescription: type: string example: "Com\xE9rcio varejista especializado de equipamentos e suprimentos de inform\xE1tica" address: type: object properties: street: type: string example: RUA locality: type: string example: CARLOS GOMES areaNumber: type: string example: '1234' additionalAddress: type: string example: ANDAR 10A 10 postcode: type: string example: '80013' localitySector: type: string example: CENTRO federationUnit: type: string example: SP country: type: object properties: code: type: string example: '105' description: type: string example: BRASIL county: type: object properties: administrativeCode: type: string example: '6639' administrativeName: type: string example: LIMEIRA municipalitiesJurisdiction: type: object properties: code: type: string example: 0811200 description: type: string example: LIMEIRA phones: type: array items: type: object properties: phoneCode: type: string example: '19' phoneNumber: type: string example: '21138250' email: type: string example: welcome@metamap.com capitalSocial: type: integer example: 77766517900 default: 0 companySize: type: string example: '05' situacaoEspecial: type: string example: '' dataSituacaoEspecial: type: string example: '' informacoesAdicionais: type: object properties: optanteSimples: type: string example: "N\xC3O" optanteMei: type: string example: "N\xC3O" listaPeriodosSimples: type: array items: type: object properties: {} shareholdersInfo: type: array items: type: object properties: shareholderType: type: string example: '2' cpfNumber: type: string example: '00000000000' shareholderName: type: string example: FILIP VICTOR qualificacao: type: string example: '10' assignationDate: type: string example: '2022-07-06' country: type: object properties: code: type: string example: '105' description: type: string example: BRASIL legalRepresentation: type: object properties: representativeCpf: type: string example: '00000000000' representativeName: type: string example: '' qualificacao: type: string example: '00' '204': description: '204' content: application/json: examples: Not found: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"brazilianCnpjExtended.notFound\"\ ,\n \"message\": \"No results were found in the Brazilian CNPJ database\"\n }\n}" Not valid parameters: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"brazilianCnpjExtended.notValidParams\"\ ,\n \"message\": \"The data passed appears to be invalid\"\n }\n}" schema: oneOf: - title: Not found type: object properties: data: {} error: type: object properties: type: type: string example: govCheckError code: type: string example: brazilianCnpjExtended.notFound message: type: string example: No results were found in the Brazilian CNPJ database - title: Not valid parameters type: object properties: data: {} error: type: object properties: type: type: string example: govCheckError code: type: string example: brazilianCnpjExtended.notValidParams message: type: string example: The data passed appears to be invalid deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/br/cnpj-extended' \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer ' \\\n--data-raw '{\n \"cnpj\": \"00000000000000\"\ ,\\\n \"callbackUrl\":\"https://some.webhook.url\"\\\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/br/cpf-light: post: summary: 'GovChecks: Brazil CPF-light' description: Verify a user's CPF number and identity. operationId: govchecks-brazil-cpf-light requestBody: content: application/json: schema: type: object required: - cpf - callbackURL properties: cpf: type: string description: CPF number. callbackURL: type: string responses: '200': description: '200' content: application/json: examples: Valid ID Example: value: "{\n \"status\": 200,\n \"id\": \"brazilian-cpf-light-validation\",\n \"error\": null,\n \"data\"\ : {\n \"fullName\": \"\",\n \"dateOfBirth\": \"1900-01-01\",\n \"cpf\": \"01234567890\"\ ,\n \"taxStatus\": \"Regular\"\n },\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" User Not Found: value: "{\n \"status\": 200,\n \"error\": {\n \"type\": \"stepError\",\n \"code\": \"brazilianCpfLight.noResults\"\ ,\n \"message\": \"The user was not found in the CPF database\"\n },\n \"data\": null,\n \"\ timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" schema: oneOf: - title: Valid ID Example type: object properties: status: type: integer example: 200 default: 0 id: type: string example: brazilian-cpf-light-validation error: {} data: type: object properties: fullName: type: string example: dateOfBirth: type: string example: '1900-01-01' cpf: type: string example: 01234567890 taxStatus: type: string example: Regular timestamp: type: string example: '2020-11-17T18:36:57.198Z' - title: User Not Found type: object properties: status: type: integer example: 200 default: 0 error: type: object properties: type: type: string example: stepError code: type: string example: brazilianCpfLight.noResults message: type: string example: The user was not found in the CPF database data: {} timestamp: type: string example: '2020-11-17T18:36:57.198Z' '202': description: '202' content: application/json: examples: Irregular Tax Status: value: "{\n \"status\": 200,\n \"error\": {\n \"type\": \"stepError\",\n \"code\": \"brazilianCpfLight.irregularTaxStatus\"\ ,\n \"message\": \"The user's tax status is irregular\"\n },\n \"data\": {\n \"fullName\"\ : \"\",\n \"dateOfBirth\": \"1900-01-01\",\n \"cpf\": \"01234567890\",\n \"taxStatus\"\ : \"Suspensa\"\n },\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" schema: type: object properties: status: type: integer example: 200 default: 0 error: type: object properties: type: type: string example: stepError code: type: string example: brazilianCpfLight.irregularTaxStatus message: type: string example: The user's tax status is irregular data: type: object properties: fullName: type: string example: dateOfBirth: type: string example: '1900-01-01' cpf: type: string example: 01234567890 taxStatus: type: string example: Suspensa timestamp: type: string example: '2020-11-17T18:36:57.198Z' deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/br/cpf-light' \\\n--header 'Content-Type:\ \ application/json' \\\n--header 'Authorization: Bearer {{ACCESS_TOKEN}}' \\\n--data-raw '{\n \"cpf\": \"01234567\"\ ,\\\n \"callbackUrl\":\"\"\\\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/br/cpf-validation: post: summary: 'GovChecks: Brazil CPF Validation' description: Verify a user's CPF number and identity. operationId: govchecks-brazil-cpf-validation requestBody: content: application/json: schema: type: object required: - cpfNumber - fullName properties: cpfNumber: type: string fullName: type: string dateOfBirth: type: string format: date mothersName: type: string fathersName: type: string documentType: type: string description: '`nationalId` or `driving-license`' documentNumber: type: string default: '1234567890' callbackURL: type: string gender: type: string description: '"m" for male, "f" for female. Returns `null` if there is no gender data.' responses: '200': description: '200' content: application/json: examples: Valid ID Example: value: "{\n \"error\": null,\n \"data\": {\n \"cpfNumberMatched\": true,\n \"gender\": \"M\",\n\ \ \"nationality\": \"Brazilian\",\n \"taxStatus\": \"regular\",\n \"fullNameSimilarity\": 1,\n\ \ \"dateOfBirthMatched\": true,\n \"documentType\": \"national-id\",\n \"documentNumberMatched\"\ : true,\n \"mothersNameSimilarity\": 1,\n \"fathersNameSimilarity\": 1\n }\n}" schema: type: object properties: error: {} data: type: object properties: cpfNumberMatched: type: boolean example: true default: true gender: type: string example: M nationality: type: string example: Brazilian taxStatus: type: string example: regular fullNameSimilarity: type: integer example: 1 default: 0 dateOfBirthMatched: type: boolean example: true default: true documentType: type: string example: national-id documentNumberMatched: type: boolean example: true default: true mothersNameSimilarity: type: integer example: 1 default: 0 fathersNameSimilarity: type: integer example: 1 default: 0 '202': description: '202' content: application/json: examples: Data Mismatch Error: value: "{\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"error.dataMismatch\",\n \ \ \"message\": \"One or more fields do no match the government database\"\n },\n \"data\": {\n \"\ cpfNumber\": \"123.456.789-01\",\n \"taxStatus\": \"regular\",\n \"dateOfBirth\": \"1901-01-02\"\ ,\n \"fullName\": \"JOHN JAMES DOE\",\n \"documentType\": null,\n \"documentNumber\": null\n\ \ }\n}" schema: type: object properties: error: type: object properties: type: type: string example: govCheckError code: type: string example: error.dataMismatch message: type: string example: One or more fields do no match the government database data: type: object properties: cpfNumber: type: string example: 123.456.789-01 taxStatus: type: string example: regular dateOfBirth: type: string example: '1901-01-02' fullName: type: string example: JOHN JAMES DOE documentType: {} documentNumber: {} deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/br/cpf-validation' \\\n--header 'Content-Type:\ \ application/json' \\\n--header 'Authorization: Bearer Token \\\n--data-raw '{\n \"cpfNumber\": \"012.345.678-90\"\ ,\n \"fullName\": \"JOHN DOE\",\n \"dateOfBirth\": \"1900-01-01\",\n \"mothersName\": \"JANE DOE\",\n \"fathersName\"\ : \"JAMES DOE\",\n \"documentType\": \"national-id\",\n \"documentNumber\": \"0123456789\",\n \"callbackUrl\"\ : \"https://webhook.site/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}'" samples-languages: - curl tags: - GovChecks /govchecks/v1/cl/registro-civil: post: summary: 'GovChecks: Chile Registro Civil' description: Verify that a user's RUN number against the Chilean Civil Registry database operationId: govchecks-chile-registro-civil requestBody: content: application/json: schema: type: object required: - runNumber - callbackUrl properties: documentNumber: type: string runNumber: type: string documentType: type: string nationality: type: string description: 3-letter country code as per [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3). default: CHL callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: Document Number is Valid: value: "{\n \"data\": {\n \"documentNumber\": \"12.142.658-7\"\n },\n \"error\": null\n}" No Document Found: value: "{\n \"error\": {\n\t \"code\": \"registroCivilError.notFound\",\n\t \"message\":\"No results\ \ were found in the Registro Civil database\"\n\t},\n \"data\": null,\n }\n}" schema: type: object properties: data: type: object properties: documentNumber: type: string example: 12.142.658-7 error: {} '503': description: '503' content: application/json: examples: Chile Registro Civil is Unavailable: value: "{\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"system.serviceUnavailable\"\ ,\n \"message\": \"The Registro Civil service is unavailable\"\n },\n \"data\": null\n\ \ }\n}" deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/cl/registro-civil \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n \"runNumber\": \"{{runNumber}}\"\ ,\n \"documentType:\": \"national-id\",\n \"nationality\": \"{{nationality}}\",\n \"documentNumber\": \"{{documentNumber}}\"\ ,\n \"callbackUrl\": \"{{webhookUrl}}\"\n}'" name: Example Request samples-languages: - curl tags: - GovChecks /govchecks/v1/co/govcheck: post: summary: 'GovChecks: Colombia Govcheck' description: Verify a user's ID card against the Colombian Civil Registry operationId: govchecks-colombia-govcheck requestBody: content: application/json: schema: type: object required: - documentNumber properties: documentNumber: type: string description: Document number for a National ID callbackUrl: type: string responses: '202': description: '202' content: application/json: examples: Document Verified: value: '' '400': description: '400' content: text/plain: examples: Result: value: '' '401': description: '401' content: application/json: examples: Bad Request: value: '' deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.prod.metamap.com/govchecks/v1/co/govcheck \\\n --header\ \ 'Accept: application/json'\n --data-raw '{\n \"documentNumber\": \"1234567890\",\n \"callbackUrl\"\ :\"{{callbackUrl}}\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/co/migraciones: post: summary: 'GovChecks: Colombia Migration Institute' description: Verify that a user has a valid immigration status in Colombia operationId: govchecks-colombia-migration-institute requestBody: content: application/json: schema: type: object required: - documentNumber - dateOfIssue - callbackUrl properties: documentNumber: type: string dateOfIssue: type: string format: date callbackUrl: type: string description: Webhook URL responses: '200': description: '200' content: application/json: examples: User Found: value: "{\n \"status\": 200,\n \"error\": null,\n \"data\": {\n \"fullName\": \"JOHN DOE\",\n \"\ dateOfBirth\": \"1990-01-01\",\n \"nationality\": \"211 CHILENA\",\n \"status\": \"VIGENTE\",\n\ \ \"dateOfExpiry\": \"2024-01-01\",\n \"dateOfIssue\": \"2021-01-01\",\n \"certificateCode\"\ : \"2202181425227532BAA6\"\n },\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" User Not Found: value: "{\n \"status\": 200,\n \"error\": {\n \"type\": \"stepError\",\n \"code\": \"colombianMigrationInstitute.noResults\"\ ,\n \"message\": \"The user was not found in the foreign immigration database\"\n },\n \"data\"\ : null,\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" schema: oneOf: - title: User Found type: object properties: status: type: integer example: 200 default: 0 error: {} data: type: object properties: fullName: type: string example: JOHN DOE dateOfBirth: type: string example: '1990-01-01' nationality: type: string example: 211 CHILENA status: type: string example: VIGENTE dateOfExpiry: type: string example: '2024-01-01' dateOfIssue: type: string example: '2021-01-01' certificateCode: type: string example: 2202181425227532BAA6 timestamp: type: string example: '2020-11-17T18:36:57.198Z' - title: User Not Found type: object properties: status: type: integer example: 200 default: 0 error: type: object properties: type: type: string example: stepError code: type: string example: colombianMigrationInstitute.noResults message: type: string example: The user was not found in the foreign immigration database data: {} timestamp: type: string example: '2020-11-17T18:36:57.198Z' deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/co/migraciones \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n \"documentNumber\": \"00000000\"\ , \n \"dateOfIssue\": \"2022-01-01\", \n \"callbackUrl\":\"https://webhook.url\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/co/ppt: post: summary: 'GovChecks: Colombia PPT' description: "Verify the validity of the Colombian PPT (Permiso por protecci\xF3n temporal = Temporary Protection Permit)" operationId: govchecks-colombia-ppt requestBody: content: application/json: schema: type: object required: - rumv - dni - dateOfBirth - callbackUrl properties: rumv: type: string description: User's RUMV number dni: type: string description: User's DNI number dateOfBirth: type: string description: Date of Birth format is DD-MM-YYYY callbackUrl: type: string description: Callback URL to receive request results. responses: '202': description: '202' content: application/json: examples: Document Verified: value: "{\n \"error\": null,\n \"data\": {\n \"fullName\": \"JHONNY ALBO TOS CRUCS\",\n \"phone\"\ : \"6715010 - 3232010811\",\n \"email\": \"jhon@gmail.com\",\n \"documentType\": \"DOCUMENTO EXTRANJERO\"\ ,\n \"dni\": \"19723043\",\n \"status\": \"IMPRESO\"\n }\n}" Result Not Found: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"colombianPpt.notFound\"\ ,\n \"message\": \"No results were found in the Colombian PPT database\"\n }\n}" schema: oneOf: - title: Document Verified type: object properties: error: {} data: type: object properties: fullName: type: string example: JHONNY ALBO TOS CRUCS phone: type: string example: 6715010 - 3232010811 email: type: string example: jhon@gmail.com documentType: type: string example: DOCUMENTO EXTRANJERO dni: type: string example: '19723043' status: type: string example: IMPRESO - title: Result Not Found type: object properties: data: {} error: type: object properties: type: type: string example: govCheckError code: type: string example: colombianPpt.notFound message: type: string example: No results were found in the Colombian PPT database '422': description: '422' content: application/json: examples: Parameters validation error: value: "{\n \"name\": \"ValidationError\",\n \"message\": \"Parameters validation error!\",\n \"code\"\ : 422,\n \"type\": \"VALIDATION_ERROR\",\n \"data\": [\n {\n \"keyword\": \"required\",\n \ \ \"dataPath\": \"\",\n \"schemaPath\": \"#/required\",\n \"params\": {\n \"missingProperty\"\ : \"dni\"\n },\n \"message\": \"should have required property 'dni'\",\n \"nodeID\": \"\ mol-safety-548d5876c6-tzq5k-27\",\n \"action\": \"govChecks.getColombianPpt\"\n }\n ]\n}" schema: type: object properties: name: type: string example: ValidationError message: type: string example: Parameters validation error! code: type: integer example: 422 default: 0 type: type: string example: VALIDATION_ERROR data: type: array items: type: object properties: keyword: type: string example: required dataPath: type: string example: '' schemaPath: type: string example: '#/required' params: type: object properties: missingProperty: type: string example: dni message: type: string example: should have required property 'dni' nodeID: type: string example: mol-safety-548d5876c6-tzq5k-27 action: type: string example: govChecks.getColombianPpt deprecated: false tags: - GovChecks /govchecks/v1/co/rues: post: summary: 'GovChecks: Colombia RUES' description: Check a business's national tax ID against Colombian Single Business and Social Registry operationId: govchecks-colombia-rues requestBody: content: application/json: schema: type: object required: - nit - callbackUrl properties: nit: type: string description: Company's national tax ID number callbackUrl: type: string description: Callback URL to receive request results. responses: '200': description: '200' content: application/json: examples: Records Found, Company is Active: value: "{\n \"status\": 200,\n \"error\": null,\n \"data\": {\n \"companyName\": \"ACME CORPORATION\"\ ,\n \"nit\": \"000000000\",\n \"shortName\": null,\n \"municipality\": \"ENVIGADO / ANTIOQUIA\"\ ,\n \"category\": \"SOCIEDAD \xF3 PERSONA JURIDICA PRINCIPAL \xF3 ESAL\",\n \"status\": \"ACTIVA\"\ ,\n \"enrollmentNumber\": \"00000\",\n \"lastRenewal\": \"2021\",\n \"renewalDate\": \"20210101\"\ ,\n \"enrollmentDate\": \"19900101\",\n \"expirationDate\": \"20810101\",\n \"enrollmentStatus\"\ : \"ACTIVA\",\n \"annullmentReason\": \"NORMAL\",\n \"companyType\": \"SOCIEDAD COMERCIAL\",\n \ \ \"organizationType\": \"SOCIEDAD ANONIMA\",\n \"enrollmentCategory\": \"SOCIEDAD \xF3 PERSONA JURIDICA\ \ PRINCIPAL \xF3 ESAL\",\n \"lastUpdate\": \"20210707\",\n \"economicActivities\": [\n \"1410\ \ Confecci\xF3n de prendas de vestir, excepto prendas de piel\",\n \"6810 Actividades inmobiliarias\ \ realizadas con bienes propios o arrendados\" ],\n \"mainLegalRepresentative\": \"0000000 - DOE\ \ JOHN\",\n \"otherLegalRepresentatives\": [\"00000000 - DOE JANE\"],\n \"entities\": [{\n \ \ \"entityName\":\"ACME CORPORATION\",\"commerceChamber\":\"BARRANQUILLA\",\"enrollmentNumber\":\"000000\"\ ,\"status\":\"CANCELADA\",\"category\":\"Agencia\",\"enrollmentDate\":\"20010328\",\"renewalDate\":\"\t\ 20100223\",\"lastRenewed\":\"\t2010\"}]\n},\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" No Entry Found: value: "{\n \"status\": 200,\n \"error\": {\n \"type\": \"stepError\",\n \"code\": \"colombianRues.noResults\"\ ,\n \"message\": \"The user was not found in the RUES database\"\n },\n \"data\": null,\n \"\ timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" Records Found, Company is Inactive: value: "{\n \"status\": 200,\n \"error\": null,\n \"data\": {\n \"companyName\": \"ACME CORPORATION\"\ ,\n \"nit\": \"000000000\",\n \"shortName\": null,\n \"municipality\": \"ENVIGADO / ANTIOQUIA\"\ ,\n \"category\": \"SOCIEDAD \xF3 PERSONA JURIDICA PRINCIPAL \xF3 ESAL\",\n \"status\": \"INACTIVA\"\ ,\n \"enrollmentNumber\": \"00000\",\n \"lastRenewal\": \"2021\",\n \"renewalDate\": \"20210101\"\ ,\n \"enrollmentDate\": \"19900101\",\n \"expirationDate\": \"20810101\",\n \"enrollmentStatus\"\ : \"INACTIVA\",\n \"annullmentReason\": \"NORMAL\",\n \"companyType\": \"SOCIEDAD COMERCIAL\",\n\ \ \"organizationType\": \"SOCIEDAD ANONIMA\",\n \"enrollmentCategory\": \"SOCIEDAD \xF3 PERSONA\ \ JURIDICA PRINCIPAL \xF3 ESAL\",\n \"lastUpdate\": \"20210707\",\n \"economicActivities\": [\n\ \ \"1410 Confecci\xF3n de prendas de vestir, excepto prendas de piel\",\n \"6810 Actividades\ \ inmobiliarias realizadas con bienes propios o arrendados\" ],\n \"mainLegalRepresentative\": \"\ 0000000 - DOE JOHN\",\n \"otherLegalRepresentatives\": [\"00000000 - DOE JANE\"],\n \"entities\"\ : [{\n \"entityName\":\"ACME CORPORATION\",\"commerceChamber\":\"BARRANQUILLA\",\"enrollmentNumber\"\ :\"000000\",\"status\":\"CANCELADA\",\"category\":\"Agencia\",\"enrollmentDate\":\"20010328\",\"renewalDate\"\ :\"\t20100223\",\"lastRenewed\":\"\t2010\"}]\n},\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" schema: type: object properties: status: type: integer example: 200 default: 0 error: type: object properties: type: type: string example: stepError code: type: string example: colombianRues.noResults message: type: string example: The user was not found in the RUES database data: {} timestamp: type: string example: '2020-11-17T18:36:57.198Z' deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/co/rues' \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n \"nit\":\"000000000\",\n\ \ \"callbackUrl\":\"https://some.webhook.url\"}'" samples-languages: - curl tags: - GovChecks /govchecks/v1/co/unified-criminal-search: post: summary: 'GovChecks: Colombia Unified Legal Search' description: Check a user's full name against Colombian police records. operationId: govchecks-colombia-unified-legal-search requestBody: content: application/json: schema: type: object required: - fullName - callbackUrl properties: fullName: type: string description: User's full legal name callbackUrl: type: string description: Callback URL to receive request results. responses: '200': description: '200' content: application/json: examples: No Records Found: value: "{\n \"status\": 200,\n \"id\": \"colombian-unified-criminal-search\",\n \"error\": null,\n \"\ data\": {\n \"results\": null\n },\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" Too Many Results: value: "{\n \"status\": 200,\n \"id\": \"colombian-unified-criminal-search\",\n \"error\": {\n \"\ type\": \"stepError\",\n \"code\": \"unifiedCriminalSearch.manyResults\",\n \"message\": \"There\ \ are too many results associated to the name obtained / provided\"\n },\n \"data\": {\n \"results\"\ : null\n },\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" Active Legal Case Found: value: "{\n \"status\": 200,\n \"id\": \"colombian-unified-criminal-search\",\n \"error\": {\n \"\ type\": \"stepError\",\n \"code\": \"unifiedCriminalSearch.activeProcesses\",\n \"message\": \"\ Active legal processes found\"\n },\n \"data\": {\n \"results\": [\n {\n \"idProceso\"\ : 00000000,\n \"llaveProceso\": \"00000000000000000000000\",\n \"fechaProceso\": \"2020-01-14T00:00:00\"\ ,\n \"fechaUltimaActuacion\": \"2020-03-11T00:00:00\",\n \"despacho\": \"JUZGADO 025 CIVIL\ \ MUNICIPAL DE BOGOT\xC1 \",\n \"departamento\": \"BOGOT\xC1\",\n \"sujetosProcesales\"\ : \"Demandante: PLANTIFF | Demandado: JANE DOE \"\n },\n {\n \"idProceso\": 00000000,\n\ \ \"llaveProceso\": \"00000000000000000000000\",\n \"fechaProceso\": \"2021-06-28T00:00:00\"\ ,\n \"fechaUltimaActuacion\": \"2021-09-10T00:00:00\",\n \"despacho\": \"JUZGADO 055 CIVIL\ \ MUNICIPAL DE BOGOT\xC1 \",\n \"departamento\": \"BOGOT\xC1\",\n \"sujetosProcesales\"\ : \"Demandante: PLAINTIFF | Demandado: JANE DOE \"\n }\n ]\n },\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\ \n}" schema: oneOf: - title: No Records Found type: object properties: status: type: integer example: 200 default: 0 id: type: string example: colombian-unified-criminal-search error: {} data: type: object properties: results: {} timestamp: type: string example: '2020-11-17T18:36:57.198Z' - title: Too Many Results type: object properties: status: type: integer example: 200 default: 0 id: type: string example: colombian-unified-criminal-search error: type: object properties: type: type: string example: stepError code: type: string example: unifiedCriminalSearch.manyResults message: type: string example: There are too many results associated to the name obtained / provided data: type: object properties: results: {} timestamp: type: string example: '2020-11-17T18:36:57.198Z' deprecated: false x-readme: code-samples: - language: curl code: "curl \n--location \n--request POST 'https://api.getmati.com/govchecks/v1/co/unified-criminal-search \\ \n\ --header 'Content-Type: application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n \"\ fullName\": \"JOHN DOE\",\n \"callbackUrl\" : \"https://some.webhook.url\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/cr/tse: post: summary: 'GovChecks: Costa Rica TSE' description: Verify a user's DNI against the Costa Rican TSE database operationId: govchecks-costa-rica-tse requestBody: content: application/json: schema: type: object required: - documentNumber - callbackURL properties: documentNumber: type: string description: The document number of a National ID callbackURL: type: string responses: '200': description: '200' content: application/json: examples: Document Validated: value: "{\n\t\"error\":null,\n\t\"data\":\n\t{\n \t\"documentNumber\": \"123456789\",\n \t\"firstName\"\ \ : \"ENRIQUE\",\n \t\"lastName\" : \"BLANCO\",\n \t\"secondLastName\" : \"MIRANDA\",\n \t\"dateOfBirth\"\ \ : \"1990-10-01\",\n \t\"nationality\" : \"COSTARRICENSE\",\n \"deceased\" :false\n\t}\n}" schema: type: object properties: error: {} data: type: object properties: documentNumber: type: string example: '123456789' firstName: type: string example: ENRIQUE lastName: type: string example: BLANCO secondLastName: type: string example: MIRANDA dateOfBirth: type: string example: '1990-10-01' nationality: type: string example: COSTARRICENSE deceased: type: boolean example: false default: true '202': description: '202' content: application/json: examples: Document Issuee is Deceased: value: "{\n\"error\":{\n\t \"code\": \"TSEError.deceased\",\n\t \"message\":\"Government records indicate\ \ the user is deceased\"\n\t},\n\"data\":\n\t{\n \t\"documentNumber\": \"123456789\",\n \t\"firstName\"\ \ : \"ENRIQUE\",\n \t\"lastName\" : \"BLANCO\",\n \t\"secondLastName\" : \"MIRANDA\",\n \t\"dateOfBirth\"\ \ : \"1990-10-01\",\n \t\"nationality\" : \"COSTARRICENSE\",\n \"deceased\" :true\n\t}\n}" schema: type: object properties: error: type: object properties: code: type: string example: TSEError.deceased message: type: string example: Government records indicate the user is deceased data: type: object properties: documentNumber: type: string example: '123456789' firstName: type: string example: ENRIQUE lastName: type: string example: BLANCO secondLastName: type: string example: MIRANDA dateOfBirth: type: string example: '1990-10-01' nationality: type: string example: COSTARRICENSE deceased: type: boolean example: true default: true '400': description: '400' content: application/json: examples: Invalid Document Number: value: "{\n \"error\": {\n\t \"code\": \"TSEError.invalidDocumentNumber\",\n\t \"message\":\"The\ \ document number appears to be invalid\"\n\t},\n \"data\": null,\n }\n}" '404': description: '404' content: application/json: examples: Document Not Found: value: "{\n \"error\": {\n\t \"code\": \"TSEError.notFound\",\n\t \"message\":\"No results were found\ \ in the TSE database\"\n\t},\n \"data\": null,\n }\n}" '503': description: '503' content: application/json: examples: Service is Unavailable: value: "{\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"system.serviceUnavailable\"\ ,\n \"message\": \"The TSE service is unavailable\"\n },\n \"data\": null\n }\n}" deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.getmati.com/govchecks/v1/cr/tse \\\n --header 'Accept:\ \ application/json'\n --data-raw '{\n \"documentNumber\": \"1234567890\",\n \"callbackUrl\"\ : \"{{callback_URL}}\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/do/rnc: post: summary: 'GovChecks: Dominican RNC' description: Validate an individual's business against the National Registry of Taxpayers operationId: govchecks-dominican-rnc requestBody: content: application/json: schema: type: object required: - documentNumber - callbackURL properties: documentNumber: type: string description: Document number from a Dominican national ID card callbackURL: type: string responses: '200': description: '200' content: application/json: examples: RNC found: value: "{\n \"status\": 200,\n \"id\": \"dominican-rnc-validation\",\n \"error\": null,\n \"data\":\ \ {\n \"fullName\": \"\",\n \"rnc\": \"01234567890\",\n \"commercialName\": \"\",\n \"category\": \"0\",\n \"paymentScheme\": \"2\",\n \"status\": \"2\"\n }\n \"\ timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" No Match Found: value: "{\n \"status\": 200,\n \"id\": \"dominican-rnc-validation\",\n \"error\": {\n \"type\"\ : \"stepError\",\n \"code\": \"dominicanRnc.noResults\",\n \"message\": \"The user was not found\ \ in the RNC database\"\n },\n \"data\": null,\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" schema: type: object properties: status: type: integer example: 200 default: 0 id: type: string example: dominican-rnc-validation error: type: object properties: type: type: string example: stepError code: type: string example: dominicanRnc.noResults message: type: string example: The user was not found in the RNC database data: {} timestamp: type: string example: '2020-11-17T18:36:57.198Z' deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/do/rnc \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n \"documentNumber\": \"\ 01234567\",\\\n \"callbackUrl\":\"\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/ke/brs: post: summary: 'GovChecks: Kenya BRS' description: Validate a business against the Kenyan Business Registration Service operationId: govchecks-kenya-brs requestBody: content: application/json: schema: type: object required: - registrationNumber - callbackURL properties: registrationNumber: type: string description: Registration number of a Kenyan business callbackURL: type: string responses: '200': description: '200' content: application/json: examples: ID Found: value: "{\n \"status\": 200,\n \"id\": \"kenyan-brs-validation\",\n \"error\": null,\n \"data\"\ : {\n\t\t\t\"registrationNumber\": \"CPR/2010/000000\",\n\t\t\t\"companyName\": \"ACME CORPORATION\",\n\ \t\t\t\"companyType\": \"CR13\",\n\t\t\t\"registrationDate\": \"2010-01-01\",\n\t\t\t\"registrationStatus\"\ : true,\n\t\t\t\"postalAddress\": \"00000 - 00000\",\n\t\t\t\"physicalAddress\": \"L.R.NO.000/0000 , \ \ SOMETHING ROAD, L.R.NO.000/0000\",\n\t\t\t\"phoneNumber\": \"+254000000000\",\n\t\t\t\"kraPIN\": \"\ P000000000H\",\n\t\t\t\"shareCapital\": \"1000 ORDINARY\",\n\t\t\t\"shareNominalValue\": 100.0,\n\t\t\t\ \"shareHolders\": [\n\t\t\t\t\"name\": \"JANE DOE\",\n\t\t\t\t\"shares\": \"2 ORDINARY\",\n\t\t\t\t\"\ idType\": \"visitor\",\n\t\t\t\t\"idNumber\": \"000000000\"\n\t\t\t], \n\t\t\t[\n\t\t\t\t\"name\": \"\ JOHN DOE\",\n\t\t\t\t\"shares\": \"5 ORDINARY\",\n\t\t\t\t\"idType\": \"citizen\",\n\t\t\t\t\"idNumber\"\ : \"0000001\"\n\t\t\t]\n\t\t\t\"verified\": \"Verified\",\n }\n \"timestamp\": \"2021-01-08T12:48:01.819Z\"\ \n}" No Results Found: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"kenyanBrs.notFound\"\ ,\n \"message\": \"No results were found in the Kenyan Brs database\"\n }\n}" schema: type: object properties: data: {} error: type: object properties: type: type: string example: govCheckError code: type: string example: kenyanBrs.notFound message: type: string example: No results were found in the Kenyan Brs database deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/ke/brs \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n \"registrationNumber\"\ : \"CPR/2010/000000\",\\\n \"callbackUrl\":\"https://some.webhook.url\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/ke/iprs: post: summary: 'GovChecks: Kenya IPRS' description: Validate an individual's national identity card against the Kenyan Integrated Population Registration System operationId: govchecks-kenya-iprs requestBody: content: application/json: schema: type: object required: - documentNumber - firstName - lastName - callbackUrl properties: documentNumber: type: string description: Document number from a Kenyan national ID card firstName: type: string description: First Name from a Kenyan National ID lastName: type: string description: Last Name from a Kenyan National ID callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: ID Found: value: "{\n \"error\": null,\n \"data\": {\n \"dateOfBirth\": \"22-09-1964\",\n \"documentNumber\"\ : \"0000000\",\n \"givenNames\": \"JOHN\",\n \"lastName\": \"DOE\",\n \"fullName\": \"JOHN DOE\"\ ,\n \"gender\": \"F\"\n }\n}" Service Unavailable: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"kenyanIprs.serviceUnavailable\"\ ,\n \"message\": \"The Kenyan Iprs service is unavailable\"\n }\n}" No Results Found: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"kenyanIprs.notFound\"\ ,\n \"message\": \"No results were found in the Kenyan Iprs database\"\n }\n}" schema: oneOf: - title: ID Found type: object properties: error: {} data: type: object properties: dateOfBirth: type: string example: 22-09-1964 documentNumber: type: string example: '0000000' givenNames: type: string example: JOHN lastName: type: string example: DOE fullName: type: string example: JOHN DOE gender: type: string example: F - title: Service Unavailable type: object properties: data: {} error: type: object properties: type: type: string example: systemError code: type: string example: kenyanIprs.serviceUnavailable message: type: string example: The Kenyan Iprs service is unavailable - title: No Results Found type: object properties: data: {} error: type: object properties: type: type: string example: govCheckError code: type: string example: kenyanIprs.notFound message: type: string example: No results were found in the Kenyan Iprs database deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/ke/iprs \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n \"documentNumber\": \"\ 00000000\",\n \"firstName\": \"Test1\",\n \"lasName\": \"Test2\",\n \"callbackUrl\":\"https://some.webhook.url\"\ \n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/mx/curp: post: summary: 'GovChecks: Mexico CURP' description: Validate a user's CURP number and identity operationId: govchecks-mexico-curp requestBody: content: application/json: schema: type: object required: - curp - callbackUrl properties: curp: type: string callbackUrl: type: string description: Webhook URL responses: '200': description: '200' content: application/json: examples: Successful Validation Example: value: "{\n \"error\": null,\n \"data\": {\n \"curp\": \"BAME921103HCHLRN00\",\n \"birthDate\":\ \ \"1992-11-03\",\n \"gender\": \"HOMBRE\",\n \"fullName\": \"BLANCO MIRANDA ENRIQUE ARTURO\",\n\ \ \"name\": \"ENRIQUE ARTURO\",\n \"surname\": \"BLANCO\",\n \"secondSurname\": \"MIRANDA\",\n\ \ \"nationality\": \"Mexico\"\n }\n}" schema: type: object properties: error: {} data: type: object properties: curp: type: string example: BAME921103HCHLRN00 birthDate: type: string example: '1992-11-03' gender: type: string example: HOMBRE fullName: type: string example: BLANCO MIRANDA ENRIQUE ARTURO name: type: string example: ENRIQUE ARTURO surname: type: string example: BLANCO secondSurname: type: string example: MIRANDA nationality: type: string example: Mexico '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.getmati.com/govchecks/v1/mx/curp \\\n --header 'Accept:\ \ application/json'\n --data-raw '{\n \"curp\": \"ABCD123456EFGHIJ78\",\n \"callbackUrl\": \"\ {webhook URL}\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/mx/ine: post: summary: 'GovChecks: Mexico INE' description: Validate a user's national ID against Mexico's National Electoral Institute operationId: govchecks-mexico-ine requestBody: content: application/json: schema: type: object required: - documentNumber - ocrNumber properties: documentNumber: type: string description: The national ID card number ocrNumber: type: string description: The national ID's OCR number subType: type: string description: The national ID card's issue version (A, B, C, or D) webhookUrl: type: string description: Webhook URL to receive asynchronous data. responses: '200': description: '200' content: application/json: examples: 'Error: The data passed appears to be invalid': value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"mexicanIne.notValidParams\"\ ,\n \"message\": \"The data passed appears to be invalid\"\n }\n}" Result: value: "{\n \"status\": 200,\n \"id\": \"mexican-ine-validation\",\n \"error\": null,\n\ \ \"data\": {\n \"documentNumber\": \"179297127\",\n \"cde\": \"BLMREN92110308H400\"\ ,\n \"ne\": \"3\",\n \"ocrNumber\": \"4526087814717\",\n \"registrationYear\"\ : \"2010\",\n \"emissionYear\": \"2018\"\n }\n}" schema: oneOf: - title: 'Error: The data passed appears to be invalid' type: object properties: data: {} error: type: object properties: type: type: string example: govCheckError code: type: string example: mexicanIne.notValidParams message: type: string example: The data passed appears to be invalid - type: object properties: status: type: integer example: 200 default: 0 id: type: string example: mexican-ine-validation error: {} data: type: object properties: documentNumber: type: string example: '179297127' cde: type: string example: BLMREN92110308H400 ne: type: string example: '3' ocrNumber: type: string example: '4526087814717' registrationYear: type: string example: '2010' emissionYear: type: string example: '2018' deprecated: false tags: - GovChecks /govchecks/v1/mx/rfc-status: post: summary: 'GovChecks: Mexico RFC Status' description: Validate CURP and RFC numbers to obtain tax data from users and companies operationId: govchecks-mexico-rfc-status requestBody: content: application/json: schema: type: object required: - callbackUrl - rfc properties: callbackUrl: type: string description: Webhook URL rfc: type: string responses: '200': description: '200' content: application/json: examples: Company, 2 Certificates Found - All OK: value: "{\n \"status\": 200,\n \"error\": null,\n \"data\": {\n \"fullName\": \"COMPANY NAME COMMERCIAL\ \ NAME\",\n \"rfc\": \"AAA000000AA0\",\n \"legalRepresentativeRfc\": \"AAAA000000A00\",\n \"\ legalRepresentativeCurp\": \"AAAA000000AAAAAA00\",\n \"certificates\": {\n \"1\": {\n \"\ serialNumber\": \"0000000000000000000\",\n \"status\": \"Activo\",\n \"type\": \"SELLO\"\ ,\n \"startDate\": \"2022-02-17 18:31:26\",\n \"endDate\": \"2026-02-17 18:31:26\",\n \ \ \"base64Certificate\": \"{{BASE_64_STRING}}\",\n \"certificateData\": {\n \"issuer\"\ : {\n \"issuerName\": \"SERVICIO DE ADMINISTRACION TRIBUTARIA\",\n \"type\": \"\ AUTORIDAD CERTIFICADORA\",\n \"authorityName\": \"SAT-IES Authority\",\n \"emailAddress\"\ : \"contacto.tecnico@sat.gob.mx\",\n \"street\": \"STREET NAME\",\n \"zipCode\"\ : \"00000\",\n \"country\": \"MX\",\n \"state\": \"CIUDAD DE MEXICO\",\n \ \ \"municipality\": \"CUAUHTEMOC\",\n \"responsible\": \"ADMINISTRACION CENTRAL DE SERVICIOS\ \ TRIBUTARIOS AL CONTRIBUYENTE\",\n \"rfc\": \"SAT970701NN3\"\n },\n \"issueDate\"\ : \"Feb 17 18:31:26 2022 GMT\",\n \"expiryDate\": \"Feb 17 18:31:26 2026 GMT\",\n \"\ issuedTo\": {\n \"companyName\": \"COMPANY NAME COMMERCIAL NAME\",\n \"commercialName\"\ : \"COMMERCIAL NAME\",\n \"otherName\": \"COMPANY NAME COMMERCIAL NAME\",\n \"companyRfc\"\ : \"AAA000000AA0\",\n \"legalRepresentativeRfc\": \"AAAA000000A00\",\n \"legalRepresentativeCurp\"\ : \"AAAA000000AAAAAA00\"\n }\n }\n },\n \"2\": {\n \"serialNumber\":\ \ \"0000000000000000000\",\n \"status\": \"Activo\",\n \"type\": \"SELLO\",\n \"\ startDate\": \"2022-02-17 18:31:26\",\n \"endDate\": \"2026-02-17 18:31:26\",\n \"base64Certificate\"\ : \"{{BASE_64_STRING}}\",\n \"certificateData\": {\n \"issuer\": {\n \"issuerName\"\ : \"SERVICIO DE ADMINISTRACION TRIBUTARIA\",\n \"type\": \"AUTORIDAD CERTIFICADORA\",\n \ \ \"authorityName\": \"SAT-IES Authority\",\n \"emailAddress\": \"contacto.tecnico@sat.gob.mx\"\ ,\n \"street\": \"STREET NAME\",\n \"zipCode\": \"06300\",\n \"country\"\ : \"MX\",\n \"state\": \"CIUDAD DE MEXICO\",\n \"municipality\": \"CUAUHTEMOC\"\ ,\n \"responsible\": \"ADMINISTRACION CENTRAL DE SERVICIOS TRIBUTARIOS AL CONTRIBUYENTE\",\n\ \ \"rfc\": \"AAA000000AA0\"\n },\n \"issueDate\": \"Feb 17 18:31:26 2022\ \ GMT\",\n \"expiryDate\": \"Feb 17 18:31:26 2026 GMT\",\n \"issuedTo\": {\n \ \ \"companyName\": \"COMPANY NAME COMMERCIAL NAME\",\n \"commercialName\": \"COMMERCIAL\ \ NAME\",\n \"otherName\": \"COMPANY NAME COMMERCIAL NAME\",\n \"companyRfc\": \"\ AAA000000AA0\",\n \"legalRepresentativeRfc\": \"AAAA000000A00\",\n \"legalRepresentativeCurp\"\ : \"AAAA000000AAAAAA00\"\n }\n }\n }\n },\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\ \n }\n}" Individual, 1 Certificate Found - All OK: value: "{\n \"status\": 200,\n \"error\": null,\n \"data\": {\n \"fullName\": \"JOHN DOE\",\n \"\ rfc\": \"AAAA000000000\",\n \"legalRepresentativeRfc\": \"AAAA000000000\",\n \"legalRepresentativeCurp\"\ : \"AAAA000000AAAAAA00\",\n \"certificates\": {\n \"1\": {\n \"serialNumber\": \"0000000000000000000\"\ ,\n \"status\": \"Activo\",\n \"type\": \"SELLO\",\n \"startDate\": \"2022-02-17\ \ 18:31:26\",\n \"endDate\": \"2026-02-17 18:31:26\",\n \"base64Certificate\": \"{{BASE_64_STRING}}\"\ ,\n \"certificateData\": {\n \"issuer\": {\n \"issuerName\": \"SERVICIO DE\ \ ADMINISTRACION TRIBUTARIA\",\n \"type\": \"AUTORIDAD CERTIFICADORA\",\n \"authorityName\"\ : \"SAT-IES Authority\",\n \"emailAddress\": \"contacto.tecnico@sat.gob.mx\",\n \ \ \"street\": \"STREET ADDRESS\",\n \"zipCode\": \"00000\",\n \"country\": \"MX\"\ ,\n \"state\": \"CIUDAD DE MEXICO\",\n \"municipality\": \"CUAUHTEMOC\",\n \ \ \"responsible\": \"ADMINISTRACION CENTRAL DE SERVICIOS TRIBUTARIOS AL CONTRIBUYENTE\",\n \ \ \"rfc\": \"SAT970701NN3\"\n },\n \"issueDate\": \"Feb 17 18:31:26 2022 GMT\"\ ,\n \"expiryDate\": \"Feb 17 18:31:26 2026 GMT\",\n \"issuedTo\": {\n \"\ companyName\": \"JOHN DOE\",\n \"name\": \"JOHN DOE\",\n \"organization\": \"JOHN\ \ DOE\",\n \"rfc\": \"AAAA000000000\",\n \"legalRepresentativeRfc\": null,\n \ \ \"legalRepresentativeCurp\": \"AAAA000000AAAAAA00\"\n }\n }\n }\n },\n\ \ \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n }\n}" No Entries Found: value: "{\n \"status\": 200,\n \"error\": {\n \"type\": \"stepError\",\n \"code\": \"mexicanRfcStatus.noResults\"\ ,\n \"message\": \"The user was not found in the RFC database\"\n },\n \"data\": null,\n \"\ timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" Company, 3 Certificate Found - Inactive: value: "{\n \"status\": 200,\n \"error\": {\n \"type\": \"stepError\",\n \"code\": \"mexicanRfcStatus.inactive\"\ ,\n \"message\": \"The RFC provided does not have any active FIEL\"\n },\n \"data\": {\n \"\ fullName\": \"COMPANY NAME COMMERCIAL NAME\",\n \"rfc\": \"AAA000000AA0\",\n \"certificates\":{\n\ \ \"1\":{\n \"serialNumber\":\"0000000000000000000\",\n \"status\":\"Activo\",\n \ \ \"type\":\"SELLO\",\n \"startDate\":\"2022-02-17 18:31:26\",\n \"endDate\":\"2026-02-17\ \ 18:31:26\",\n \"base64Certificate\":\"{{BASE_64_STRING}}\"\n },\n \"2\":{\n \ \ \"serialNumber\":\"0000000000000000000\",\n \"status\":\"Revocado\",\n \"type\":\"SELLO\"\ ,\n \"startDate\":\"\t2022-02-17 18:31:26\",\n \"endDate\":\"2026-02-17 18:31:26\",\n \ \ \"base64Certificate\":\"{{BASE_64_STRING}}\"\n },\n \"3\":{\n \"serialNumber\"\ :\"0000000000000000000\",\n \"status\":\"Revocado\",\n \"type\":\"FIEL\",\n \"startDate\"\ :\"\t2022-02-17 18:31:26\",\n \"endDate\":\"2026-02-17 18:31:26\",\n \"base64Certificate\"\ :\"{{BASE_64_STRING}}\"\n }\n }\n },\n \"timestamp\": \"2020-11-17T18:36:57.198Z\"\n}" schema: oneOf: - title: Company, 2 Certificates Found - All OK type: object properties: status: type: integer example: 200 default: 0 error: {} data: type: object properties: fullName: type: string example: COMPANY NAME COMMERCIAL NAME rfc: type: string example: AAA000000AA0 legalRepresentativeRfc: type: string example: AAAA000000A00 legalRepresentativeCurp: type: string example: AAAA000000AAAAAA00 certificates: type: object properties: '1': type: object properties: serialNumber: type: string example: '0000000000000000000' status: type: string example: Activo type: type: string example: SELLO startDate: type: string example: '2022-02-17 18:31:26' endDate: type: string example: '2026-02-17 18:31:26' base64Certificate: type: string example: '{{BASE_64_STRING}}' certificateData: type: object properties: issuer: type: object properties: issuerName: type: string example: SERVICIO DE ADMINISTRACION TRIBUTARIA type: type: string example: AUTORIDAD CERTIFICADORA authorityName: type: string example: SAT-IES Authority emailAddress: type: string example: contacto.tecnico@sat.gob.mx street: type: string example: STREET NAME zipCode: type: string example: '00000' country: type: string example: MX state: type: string example: CIUDAD DE MEXICO municipality: type: string example: CUAUHTEMOC responsible: type: string example: ADMINISTRACION CENTRAL DE SERVICIOS TRIBUTARIOS AL CONTRIBUYENTE rfc: type: string example: SAT970701NN3 issueDate: type: string example: Feb 17 18:31:26 2022 GMT expiryDate: type: string example: Feb 17 18:31:26 2026 GMT issuedTo: type: object properties: companyName: type: string example: COMPANY NAME COMMERCIAL NAME commercialName: type: string example: COMMERCIAL NAME otherName: type: string example: COMPANY NAME COMMERCIAL NAME companyRfc: type: string example: AAA000000AA0 legalRepresentativeRfc: type: string example: AAAA000000A00 legalRepresentativeCurp: type: string example: AAAA000000AAAAAA00 '2': type: object properties: serialNumber: type: string example: '0000000000000000000' status: type: string example: Activo type: type: string example: SELLO startDate: type: string example: '2022-02-17 18:31:26' endDate: type: string example: '2026-02-17 18:31:26' base64Certificate: type: string example: '{{BASE_64_STRING}}' certificateData: type: object properties: issuer: type: object properties: issuerName: type: string example: SERVICIO DE ADMINISTRACION TRIBUTARIA type: type: string example: AUTORIDAD CERTIFICADORA authorityName: type: string example: SAT-IES Authority emailAddress: type: string example: contacto.tecnico@sat.gob.mx street: type: string example: STREET NAME zipCode: type: string example: '06300' country: type: string example: MX state: type: string example: CIUDAD DE MEXICO municipality: type: string example: CUAUHTEMOC responsible: type: string example: ADMINISTRACION CENTRAL DE SERVICIOS TRIBUTARIOS AL CONTRIBUYENTE rfc: type: string example: AAA000000AA0 issueDate: type: string example: Feb 17 18:31:26 2022 GMT expiryDate: type: string example: Feb 17 18:31:26 2026 GMT issuedTo: type: object properties: companyName: type: string example: COMPANY NAME COMMERCIAL NAME commercialName: type: string example: COMMERCIAL NAME otherName: type: string example: COMPANY NAME COMMERCIAL NAME companyRfc: type: string example: AAA000000AA0 legalRepresentativeRfc: type: string example: AAAA000000A00 legalRepresentativeCurp: type: string example: AAAA000000AAAAAA00 timestamp: type: string example: '2020-11-17T18:36:57.198Z' - title: Individual, 1 Certificate Found - All OK type: object properties: status: type: integer example: 200 default: 0 error: {} data: type: object properties: fullName: type: string example: JOHN DOE rfc: type: string example: AAAA000000000 legalRepresentativeRfc: type: string example: AAAA000000000 legalRepresentativeCurp: type: string example: AAAA000000AAAAAA00 certificates: type: object properties: '1': type: object properties: serialNumber: type: string example: '0000000000000000000' status: type: string example: Activo type: type: string example: SELLO startDate: type: string example: '2022-02-17 18:31:26' endDate: type: string example: '2026-02-17 18:31:26' base64Certificate: type: string example: '{{BASE_64_STRING}}' certificateData: type: object properties: issuer: type: object properties: issuerName: type: string example: SERVICIO DE ADMINISTRACION TRIBUTARIA type: type: string example: AUTORIDAD CERTIFICADORA authorityName: type: string example: SAT-IES Authority emailAddress: type: string example: contacto.tecnico@sat.gob.mx street: type: string example: STREET ADDRESS zipCode: type: string example: '00000' country: type: string example: MX state: type: string example: CIUDAD DE MEXICO municipality: type: string example: CUAUHTEMOC responsible: type: string example: ADMINISTRACION CENTRAL DE SERVICIOS TRIBUTARIOS AL CONTRIBUYENTE rfc: type: string example: SAT970701NN3 issueDate: type: string example: Feb 17 18:31:26 2022 GMT expiryDate: type: string example: Feb 17 18:31:26 2026 GMT issuedTo: type: object properties: companyName: type: string example: JOHN DOE name: type: string example: JOHN DOE organization: type: string example: JOHN DOE rfc: type: string example: AAAA000000000 legalRepresentativeRfc: {} legalRepresentativeCurp: type: string example: AAAA000000AAAAAA00 timestamp: type: string example: '2020-11-17T18:36:57.198Z' - title: No Entries Found type: object properties: status: type: integer example: 200 default: 0 error: type: object properties: type: type: string example: stepError code: type: string example: mexicanRfcStatus.noResults message: type: string example: The user was not found in the RFC database data: {} timestamp: type: string example: '2020-11-17T18:36:57.198Z' deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n--url https://api.getmati.com/govchecks/v1/mx/rfc-status \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw {\n \"rfc\": \"BAME000000000\"\ ,\n \"callbackUrl\":\"https://some.webhook.url\"\n }" samples-languages: - curl tags: - GovChecks /govchecks/v1/ng/cac-affiliates: post: summary: 'GovChecks: Nigeria CAC Affiliates' description: Returns major affiliate names and titles for the given companies. operationId: govchecks-nigeria-cac-affiliates requestBody: content: application/json: schema: type: object required: - companyIds - callbackUrl properties: companyIds: type: array description: Enter a list of company Ids (returned by Nigeria CAC endpoint). items: type: string callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"error\": null,\n \"data\": {\n \"affiliates\": {\n \"0000000\": [\n {\n \ \ \"accreditationNumber\": \"CAC-ACC-1029384\",\n \"address\": \"17 Adebayo Crescent,\ \ Victoria Island, Lagos\",\n \"city\": \"Lagos\",\n \"dateOfBirth\": \"1985-11-22\"\ ,\n \"email\": \"nkechi.udeh@fabrikamsolutions.ng\",\n \"idNumber\": \"NIMC-0019283745\"\ ,\n \"idType\": \"National ID\",\n \"name\": \"Nkechi Udeh\",\n \"phoneNumber\"\ : \"+234 802 456 7890\",\n \"position\": \"Managing Director\",\n \"shares\": \"20000\"\ ,\n \"status\": \"ACTIVE\"\n }\n ],\n \"1111111\": [\n {\n \"\ accreditationNumber\": \"CAC-ACC-7483920\",\n \"address\": \"Plot 4, Ahmadu Bello Way, Garki\ \ 2, Abuja\",\n \"city\": \"Abuja\",\n \"dateOfBirth\": \"1978-03-09\",\n \"\ email\": \"tunde.adelaja@fabrikamsolutions.ng\",\n \"idNumber\": \"NIMC-0098374653\",\n \ \ \"idType\": \"Passport\",\n \"name\": \"Tunde Adelaja\",\n \"phoneNumber\": \"\ +234 805 332 1100\",\n \"position\": \"Director\",\n \"shares\": \"15000\",\n \ \ \"status\": \"ACTIVE\"\n }\n ]\n }\n }\n}" No Results Found: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"nigerianCacAffiliates.notFound\"\ ,\n \"message\": \"No results were found in the Nigerian CAC Affiliates database\"\n }\n}" schema: oneOf: - type: object properties: error: {} data: type: object properties: affiliates: type: object properties: '1111111': type: array items: type: object properties: accreditationNumber: type: string example: CAC-ACC-7483920 address: type: string example: Plot 4, Ahmadu Bello Way, Garki 2, Abuja city: type: string example: Abuja dateOfBirth: type: string example: '1978-03-09' email: type: string example: tunde.adelaja@fabrikamsolutions.ng idNumber: type: string example: NIMC-0098374653 idType: type: string example: Passport name: type: string example: Tunde Adelaja phoneNumber: type: string example: +234 805 332 1100 position: type: string example: Director shares: type: string example: '15000' status: type: string example: ACTIVE '0000000': type: array items: type: object properties: accreditationNumber: type: string example: CAC-ACC-1029384 address: type: string example: 17 Adebayo Crescent, Victoria Island, Lagos city: type: string example: Lagos dateOfBirth: type: string example: '1985-11-22' email: type: string example: nkechi.udeh@fabrikamsolutions.ng idNumber: type: string example: NIMC-0019283745 idType: type: string example: National ID name: type: string example: Nkechi Udeh phoneNumber: type: string example: +234 802 456 7890 position: type: string example: Managing Director shares: type: string example: '20000' status: type: string example: ACTIVE - title: No Results Found type: object properties: data: {} error: type: object properties: type: type: string example: govCheckError code: type: string example: nigerianCacAffiliates.notFound message: type: string example: No results were found in the Nigerian CAC Affiliates database '422': description: '422' content: application/json: examples: Invalid Params (companyIds not an array): value: "{\n \"name\": \"ValidationError\",\n \"message\": \"Parameters validation error!\",\n \"\ code\": 422,\n \"type\": \"VALIDATION_ERROR\",\n \"data\": [\n {\n \"keyword\"\ : \"type\",\n \"dataPath\": \"/companyIds\",\n \"schemaPath\": \"#/properties/companyIds/type\"\ ,\n \"params\": {\n \"type\": \"array\"\n },\n \"message\"\ : \"should be array\",\n \"action\": \"govChecks.getNigerianCacAffiliates\"\n }\n \ \ ]\n}" Invalid Params (empty companyIds): value: "{\n \"name\": \"ValidationError\",\n \"message\": \"Parameters validation error!\",\n \"\ code\": 422,\n \"type\": \"VALIDATION_ERROR\",\n \"data\": [\n {\n \"keyword\"\ : \"minItems\",\n \"dataPath\": \"/companyIds\",\n \"schemaPath\": \"#/properties/companyIds/minItems\"\ ,\n \"params\": {\n \"limit\": 1\n },\n \"message\": \"\ should NOT have fewer than 1 items\",\n \"nodeID\": \"safety-69d9b6955-wmz8s-1\",\n \ \ \"action\": \"govChecks.getNigerianCacAffiliates\"\n }\n ]\n}" Invalid Params (companyIds has no strings): value: "{\n \"name\": \"ValidationError\",\n \"message\": \"Parameters validation error!\",\n \"\ code\": 422,\n \"type\": \"VALIDATION_ERROR\",\n \"data\": [\n {\n \"keyword\"\ : \"type\",\n \"dataPath\": \"/companyIds/0\",\n \"schemaPath\": \"#/properties/companyIds/items/type\"\ ,\n \"params\": {\n \"type\": \"string\"\n },\n \"message\"\ : \"should be string\",\n \"action\": \"govChecks.getNigerianCacAffiliates\"\n }\n \ \ ]\n}" schema: oneOf: - title: Invalid Params (companyIds not an array) type: object properties: name: type: string example: ValidationError message: type: string example: Parameters validation error! code: type: integer example: 422 default: 0 type: type: string example: VALIDATION_ERROR data: type: array items: type: object properties: keyword: type: string example: type dataPath: type: string example: /companyIds schemaPath: type: string example: '#/properties/companyIds/type' params: type: object properties: type: type: string example: array message: type: string example: should be array action: type: string example: govChecks.getNigerianCacAffiliates - title: Invalid Params (empty companyIds) type: object properties: name: type: string example: ValidationError message: type: string example: Parameters validation error! code: type: integer example: 422 default: 0 type: type: string example: VALIDATION_ERROR data: type: array items: type: object properties: keyword: type: string example: minItems dataPath: type: string example: /companyIds schemaPath: type: string example: '#/properties/companyIds/minItems' params: type: object properties: limit: type: integer example: 1 default: 0 message: type: string example: should NOT have fewer than 1 items nodeID: type: string example: safety-69d9b6955-wmz8s-1 action: type: string example: govChecks.getNigerianCacAffiliates - title: Invalid Params (companyIds has no strings) type: object properties: name: type: string example: ValidationError message: type: string example: Parameters validation error! code: type: integer example: 422 default: 0 type: type: string example: VALIDATION_ERROR data: type: array items: type: object properties: keyword: type: string example: type dataPath: type: string example: /companyIds/0 schemaPath: type: string example: '#/properties/companyIds/items/type' params: type: object properties: type: type: string example: string message: type: string example: should be string action: type: string example: govChecks.getNigerianCacAffiliates deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.prod.metamap.com/govchecks/v1/ng/cac-affiliates \\\n --header\ \ 'accept: application/json' \\\n --header 'authorization: Bearer dsfgsdfgsdfgsdfg' \\\n --header 'content-type:\ \ application/json' \\\n --data '\n{\n \"companyIds\": [\n \"0000000\",\n \"1111111\"\n ],\n \"callbackUrl\"\ : \"http://callback.url\"\n}\n'" name: Example Request samples-languages: - curl tags: - GovChecks /govchecks/v1/ng/cac: post: summary: 'GovChecks: Nigeria CAC' description: Verify that a company's Corporate Affairs Commission (CAC) number is valid. operationId: govchecks-nigeria-cac requestBody: content: application/json: schema: type: object required: - registrationNumber properties: registrationNumber: type: string description: Enter a registered company number. Alpha-numeric values only. callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: Active Companies Found: value: "{\n \"error\": null,\n \"data\": {\n \"id\": \"1234567\",\n \"type\": \"BN\",\n \"companyName\"\ : \"ACME CORPORATION\",\n \"cacNumber\": \"BN0000000\",\n \"status\": \"ACTIVE\",\n \"companyAddress\"\ : \"123 MAIN STREET\",\n \"companyEmail\": \"contact@acme.corp\",\n \"registrationDate\": \"2001-01-01T11:30:34.848+00:00\"\ ,\n \"companies\": [\n \t{\n \"id\": \"8901234\",\n \"type\": \"BN\",\n \"\ companyName\": \"LOREM IPSUM INDUSTRIES\",\n \"cacNumber\": \"BN0000000\",\n \"status\"\ : \"ACTIVE\",\n \"companyAddress\": \"123 MAIN STREET\",\n \"companyEmail\": \"contact@lorem.industries\"\ ,\n \"registrationDate\": \"2012-05-01T11:30:34.848+00:00\",\n \t}, \n ...\n ]\n }\n\ }" No Companies Found: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"nigerianCac.notFound\"\ ,\n \"message\": \"No results were found in the Nigerian CAC database\"\n }\n}" Company Invalid Status: value: "{\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"nigerianCac.invalidStatus\"\ ,\n \"message\": \"At least one of the companies is inactive\"\n },\n \"data\": {\n \"id\": \"\ 8394118\",\n \"type\": \"RC\",\n \"companyName\": \"Fabrikam Solution\",\n \"companyAddress\"\ : \"17 Adebayo Crescent, Victoria Island, Lagos, Nigeria\",\n \"companyEmail\": \"info@fabrikamsolutions.ng\"\ ,\n \"cacNumber\": \"RC0000000\",\n \"status\": \"INACTIVE\",\n \"registrationDate\": \"2022-12-13T09:23:24.094+00:00\"\ ,\n \"companies\": [\n {\n \"id\": \"7543982\",\n \"type\": \"RC\",\n \"\ companyName\": \"Contoso Engineering Ltd\",\n \"companyAddress\": \"42 Olusegun Obasanjo Way, Abuja,\ \ FCT, Nigeria\",\n \"companyEmail\": \"contact@contosoeng.ng\",\n \"cacNumber\": \"RC000000\"\ ,\n \"status\": \"ACTIVE\",\n \"registrationDate\": \"2019-06-04T14:10:59.000+00:00\"\n\ \ \t\t}\n ]\n }\n}" schema: oneOf: - title: No Companies Found type: object properties: data: {} error: type: object properties: type: type: string example: govCheckError code: type: string example: nigerianCac.notFound message: type: string example: No results were found in the Nigerian CAC database - title: Company Invalid Status type: object properties: error: type: object properties: type: type: string example: govCheckError code: type: string example: nigerianCac.invalidStatus message: type: string example: At least one of the companies is inactive data: type: object properties: id: type: string example: '8394118' type: type: string example: RC companyName: type: string example: Fabrikam Solution companyAddress: type: string example: 17 Adebayo Crescent, Victoria Island, Lagos, Nigeria companyEmail: type: string example: info@fabrikamsolutions.ng cacNumber: type: string example: RC0000000 status: type: string example: INACTIVE registrationDate: type: string example: '2022-12-13T09:23:24.094+00:00' companies: type: array items: type: object properties: id: type: string example: '7543982' type: type: string example: RC companyName: type: string example: Contoso Engineering Ltd companyAddress: type: string example: 42 Olusegun Obasanjo Way, Abuja, FCT, Nigeria companyEmail: type: string example: contact@contosoeng.ng cacNumber: type: string example: RC000000 status: type: string example: ACTIVE registrationDate: type: string example: '2019-06-04T14:10:59.000+00:00' deprecated: false x-readme: code-samples: - language: curl code: "curl \n--location \n--request POST 'https://api.getmati.com/govchecks/v1/ng/cac' \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer {TOKEN}' \\ \n--data-raw '{\n\t\"registrationNumber\"\ : \"BN0000000\", \\\n\t\"callbackUrl\": \"https://some.webhook.url\"\n}'" samples-languages: - curl tags: - GovChecks /govchecks/v1/ng/dl: post: summary: 'GovChecks: Nigeria Driver License' description: Verify a user's driver license number operationId: govchecks-nigeria-driver-license requestBody: content: application/json: schema: type: object required: - documentNumber - firstName - lastName - callbackUrl properties: documentNumber: type: string firstName: type: string lastName: type: string callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: Entry Found: value: "{\n \"status\": 200,\n \"id\": \"nigerian-drivers-license-validation\",\n \"error\": null,\n\ \ \"data\": {\n \"licenseNo\": \"XXX00000YY00\",\n \"firstname\": \"JOHN\n \"lastname\": \"\ DOE\",\n \"issuedDate\": \"10-07-2019\",\n \"expiryDate\": \"15-06-2024\",\n \"stateOfIssue\"\ : \"EDO\",\n \"gender\": \"Male\",\n \"birthdate\": \"15-06-1990\",\n \"middlename\": \"\",\n\ \ \"governmentFaceMatch\": {\n \"photo\": \"{{BASE_64_IMAGE}}\",\n \"matched\": true,\n \ \ \"score\": 100\n }\n },\n \"timestamp\": \"2021-01-08T12:48:01.819Z\"\n}" No Entry Found: value: "{\n \"status\": 200,\n \"id\": \"nigerian-drivers-license-validation\",\n \"error\": {\n \ \ \"code\": \"error.noResults\",\n \"message\": \"Nothing was found in the NIN or VIN databases\"\n\ \ },\n \"data\": null,\n \"timestamp\": \"2021-01-08T12:48:01.819Z\"\n}" schema: type: object properties: status: type: integer example: 200 default: 0 id: type: string example: nigerian-drivers-license-validation error: type: object properties: code: type: string example: error.noResults message: type: string example: Nothing was found in the NIN or VIN databases data: {} timestamp: type: string example: '2021-01-08T12:48:01.819Z' deprecated: false x-readme: code-samples: - language: curl code: "curl \n--location \n--request POST 'https://api.getmati.com/govchecks/v1/ng/dl' \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\"documentNumber\": \"XXX00000YY00\"\ , \n\t\t\t\t\t\t \"firstName\": \"Test1\", \n \"lastName\": \"Test2\", \n \"callbackUrl\"\ : \"{{webhookUrl}}\"\n }'" name: Example Request samples-languages: - curl tags: - GovChecks /govchecks/v1/ng/nin: post: summary: 'GovChecks: Nigeria NIN' description: Verify a user's National Identity Number operationId: govchecks-nigeria-nin-1 requestBody: content: application/json: schema: type: object properties: documentNumber: type: string firstName: type: string lastName: type: string dateOfBirth: type: string phone: type: string callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"status\": 200,\n \"id\": \"nigerian-nin-validation\",\n \"error\": null,\n \"data\": {\n\ \ \"firstName\": string,\n \"lastName\": string,\n \"middleName\": string,\n \"gender\": string,\n\ \ \"phone\": string,\n \"dateOfBirth\": string,\n \"nationality\": string,\n \"nin\": string,\n\ \ \"photo\": string,\n \"profession\": string,\n \"stateOfOrigin\": string,\n \"lgaOfOrigin\"\ : string,\n \"placeOfOrigin\": string,\n \"title\": string,\n \"height\": string,\n \"email\"\ : string,\n \"birthState\": string,\n \"birthCountry\": string,\n \"nextOfKin\": {\n \"\ firstName\": string,\n \"lastName\": string,\n \"middleName\": string,\n \"address1\":\ \ string,\n \"address2\": string,\n \"lga\": string,\n \"state\": string,\n \"town\"\ : string\n },\n \"nspokenlang\": string,\n \"religion\": string,\n \"signature\": string,\n\ \ \"residence\": {\n \"address1\": string,\n \"lga\": string,\n \"state\": string\n\ \ },\n \"fieldMatches\": {\n \"lastName\": string\n }\n }" '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: "curl\n--location\n--request POST 'https://api.getmati.com/govchecks/v1/ng/nin' \\\n--header 'Authorization:\ \ Bearer '{{access_token}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"documentNumber\"\ : string,\n \"firstName\": string,\n \"lastName\": string,\n \"dateOfBirth\": string,\n \"phone\"\ : string,\n \"callbackUrl\": string\n}'" samples-languages: - curl tags: - GovChecks /govchecks/v1/ng/tin: post: summary: 'GovChecks: Nigeria TIN' description: Verify a company's Tax Identification Number operationId: govchecks-nigeria-tin requestBody: content: application/json: schema: type: object required: - taxNumber - callbackUrl properties: taxNumber: type: string description: Either FIRS or JBT tax ID number. callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: All data confirmed: value: "{\n \"error\": null,\n \"data\": {\n \"companyName\": \"ACME CORPORATION\",\n \"FirsNumber\"\ : \"00000000-0000\",\n \"CacNumber\": \"RC0000000\",\n \"JtbNumber\": \"0000000000\",\n \"taxOffice\"\ : \"MSTO VICTORIA ISLAND\",\n \"companyPhone\": \"+0000000000000\",\n \"companyEmail\": \"contact@acme.corp\"\ \n }\n}" 'No data found: invalid parameters': value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"nigerianTin.notValidParams\"\ ,\n \"message\": \"The data passed appears to be invalid\"\n }\n}" schema: oneOf: - title: All data confirmed type: object properties: error: {} data: type: object properties: companyName: type: string example: ACME CORPORATION FirsNumber: type: string example: 00000000-0000 CacNumber: type: string example: RC0000000 JtbNumber: type: string example: '0000000000' taxOffice: type: string example: MSTO VICTORIA ISLAND companyPhone: type: string example: '+0000000000000' companyEmail: type: string example: contact@acme.corp - title: 'No data found: invalid parameters' type: object properties: data: {} error: type: object properties: type: type: string example: govCheckError code: type: string example: nigerianTin.notValidParams message: type: string example: The data passed appears to be invalid deprecated: false x-readme: code-samples: - language: curl code: "curl \n--location \n--request POST 'https://api.getmati.com/govchecks/v1/ng/tin' \\ \n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n\t\"taxNumber\": \"000000000-0000\"\ , \\\n\t\"callbackUrl\": \"https://some.webhook.url\" \\\n}'" name: Example Request samples-languages: - curl tags: - GovChecks /govchecks/v1/ng/vin: post: summary: 'GovChecks: Nigeria VIN' description: Verify a user's Voting Identity Number operationId: govchecks-nigeria-vin requestBody: content: application/json: schema: type: object required: - documentNumber - firstName - lastName - dateOfBirth - callbackUrl properties: documentNumber: type: string firstName: type: string lastName: type: string dateOfBirth: type: string format: date callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: Entry Found: value: "{\n \"status\": 200,\n \"id\": \"nigean-national-id-validation\",\n \"error\": null,\n \"data\"\ : {\n \"firstname\": \"JOHN\",\n \"lastname\": \"DOE\",\n \"middlename\": \"JOHN\",\n \ \ \"gender\": \"m\",\n \"occupation\": \"BANKING AND FINANCE\",\n \"stateOfOrigin\": \"\ Abia\",\n \"lgaOfOrigin\": \"Arochukwu\",\n \"onspokenlang\": \"IGBO\",\n\t\t\t\"pollingUnit\"\ : \"TAPA ST. BY HOUSE NO. 35 - I\"\n },\n \"timestamp\": \"2021-01-08T12:48:01.819Z\"\n}" Entry Not Found: value: "{\n \"status\": 200,\n \"id\": \"nigerian-national-id-validation\",\n \"error\": {\n \"code\"\ : \"error.noResults\",\n \"message\": \"Nothing was found in the NIN or VIN databases\"\n },\n \"\ data\": null,\n \"timestamp\": \"2021-01-08T12:48:01.819Z\"\n}" schema: oneOf: - title: Entry Found type: object properties: status: type: integer example: 200 default: 0 id: type: string example: nigean-national-id-validation error: {} data: type: object properties: firstname: type: string example: JOHN lastname: type: string example: DOE middlename: type: string example: JOHN gender: type: string example: m occupation: type: string example: BANKING AND FINANCE stateOfOrigin: type: string example: Abia lgaOfOrigin: type: string example: Arochukwu onspokenlang: type: string example: IGBO pollingUnit: type: string example: TAPA ST. BY HOUSE NO. 35 - I timestamp: type: string example: '2021-01-08T12:48:01.819Z' - title: Entry Not Found type: object properties: status: type: integer example: 200 default: 0 id: type: string example: nigerian-national-id-validation error: type: object properties: code: type: string example: error.noResults message: type: string example: Nothing was found in the NIN or VIN databases data: {} timestamp: type: string example: '2021-01-08T12:48:01.819Z' deprecated: false x-readme: code-samples: - language: curl code: "curl \n--location \n--request POST 'https://api.getmati.com/govchecks/v1/ng/vin \\\n--header 'Content-Type:\ \ application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\"documentNumber\": \"00000000\"\ , \n \"firstName\": \"Test1\", \n \"lastName\": \"Test2\", \n \"dateOfBirth\"\ : \"2000-10-10\", \n \"callbackUrl\": \"{{webhookUrl}}\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/pa/tse-facematch: post: summary: 'GovChecks: Panama TSE Facematch' description: "Validates national identity information and performs biometric face verification against the government\u2019\ s biometric database." operationId: govchecks-panama-tse-facematch parameters: - name: Content-Type in: header schema: type: string default: application/json requestBody: content: application/json: schema: type: object required: - documentNumber - selfie - callbackUrl properties: documentNumber: type: string selfie: type: string description: Image in Base64 callbackUrl: type: string metadata: type: string format: json responses: '200': description: '200' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - GovChecks /govchecks/v1/pa/tse: post: summary: 'GovChecks: Panama TSE' description: Verify a user's DNI against the Panamanian TSE database via document number and a selfie photo operationId: govchecks-panama-tse requestBody: content: application/json: schema: type: object required: - documentNumber - selfie - callbackUrl properties: documentNumber: type: string description: 'DNI number from the national ID. E.g: "0-000-0000"' selfie: type: string description: 'Selfie photo from the document owner (file size limit: 2mb)' format: binary callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"data\": {\n \"searchId\": 000000,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : true\n },\n \"error\": null\n}" Person Underage: value: "{\n \"data\": {\n \"searchId\": 123456,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : false\n },\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"panamanianTse.personUnderaged\"\ ,\n \"message\": \"Person is under 12 years old\"\n }\n}" Person Deceased: value: "{\n \"data\": {\n \"searchId\": 123456,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : false\n },\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"panamanianTse.personDeceased\"\ ,\n \"message\": \"Person is deceased\"\n }\n}" Invalid Registration: value: "{\n \"data\": {\n \"searchId\": 123456,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : false\n },\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"panamanianTse.personInvalidRegistration\"\ ,\n \"message\": \"Person has invalid registration\"\n }\n}" Person Unrecognized: value: "{\n \"data\": {\n \"searchId\": 123456,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : false\n },\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"panamanianTse.personUnrecognized\"\ ,\n \"message\": \"Person image is not unrecognized\"\n }\n}" User Not Found: value: "{\n \"data\": {\n \"searchId\": 123456,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : false\n },\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"panamanianTse.userNotFound\"\ ,\n \"message\": \"User is not found\"\n }\n}" Invalid Input: value: "{\n \"data\": {\n \"searchId\": 123456,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : false\n },\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"panamanianTse.invalidInput\"\ ,\n \"message\": \"Provided input data is not valid\"\n }\n}" Image is too big: value: "{\n \"data\": {\n \"searchId\": 123456,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : false\n },\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"panamanianTse.tooBigImage\"\ ,\n \"message\": \"Person image is too big\"\n }\n}" schema: oneOf: - title: Person Underage type: object properties: data: type: object properties: searchId: type: integer example: 123456 default: 0 documentNumber: type: string example: 1-234-567 valid: type: boolean example: false default: true error: type: object properties: type: type: string example: govCheckError code: type: string example: panamanianTse.personUnderaged message: type: string example: Person is under 12 years old - title: Person Deceased type: object properties: data: type: object properties: searchId: type: integer example: 123456 default: 0 documentNumber: type: string example: 1-234-567 valid: type: boolean example: false default: true error: type: object properties: type: type: string example: govCheckError code: type: string example: panamanianTse.personDeceased message: type: string example: Person is deceased - title: Invalid Registration type: object properties: data: type: object properties: searchId: type: integer example: 123456 default: 0 documentNumber: type: string example: 1-234-567 valid: type: boolean example: false default: true error: type: object properties: type: type: string example: govCheckError code: type: string example: panamanianTse.personInvalidRegistration message: type: string example: Person has invalid registration - title: Person Unrecognized type: object properties: data: type: object properties: searchId: type: integer example: 123456 default: 0 documentNumber: type: string example: 1-234-567 valid: type: boolean example: false default: true error: type: object properties: type: type: string example: govCheckError code: type: string example: panamanianTse.personUnrecognized message: type: string example: Person image is not unrecognized - title: User Not Found type: object properties: data: type: object properties: searchId: type: integer example: 123456 default: 0 documentNumber: type: string example: 1-234-567 valid: type: boolean example: false default: true error: type: object properties: type: type: string example: govCheckError code: type: string example: panamanianTse.userNotFound message: type: string example: User is not found - title: Invalid Input type: object properties: data: type: object properties: searchId: type: integer example: 123456 default: 0 documentNumber: type: string example: 1-234-567 valid: type: boolean example: false default: true error: type: object properties: type: type: string example: govCheckError code: type: string example: panamanianTse.invalidInput message: type: string example: Provided input data is not valid - title: Image is too big type: object properties: data: type: object properties: searchId: type: integer example: 123456 default: 0 documentNumber: type: string example: 1-234-567 valid: type: boolean example: false default: true error: type: object properties: type: type: string example: govCheckError code: type: string example: panamanianTse.tooBigImage message: type: string example: Person image is too big '500': description: '500' content: application/json: examples: Service Unavailable: value: "{\n \"data\": {\n \"searchId\": 123456,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : false\n },\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"panamanianTse.serviceUnavailable\"\ ,\n \"message\": \"Panama TSE service is unavailable\"\n }\n}" Internal Error: value: "{\n \"data\": {\n \"searchId\": 123456,\n \"documentNumber\": \"1-234-567\",\n \"valid\"\ : false\n },\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"system.internalError\"\ ,\n \"message\": \"Internal error has occurred\"\n }\n}" schema: oneOf: - title: Service Unavailable type: object properties: data: type: object properties: searchId: type: integer example: 123456 default: 0 documentNumber: type: string example: 1-234-567 valid: type: boolean example: false default: true error: type: object properties: type: type: string example: systemError code: type: string example: panamanianTse.serviceUnavailable message: type: string example: Panama TSE service is unavailable - title: Internal Error type: object properties: data: type: object properties: searchId: type: integer example: 123456 default: 0 documentNumber: type: string example: 1-234-567 valid: type: boolean example: false default: true error: type: object properties: type: type: string example: systemError code: type: string example: system.internalError message: type: string example: Internal error has occurred deprecated: false x-readme: code-samples: - language: curl code: 'curl --location ''https://api.getmati.com/govchecks/v1/pa/tse'' \ --header ''Authorization: Bearer {{TOKEN}}'' \ --form ''documentNumber="0-000-0000"'' \ --form ''callbackUrl="https://some.webhook.url"'' \ --form ''selfie=@"/filepath/selfie.jpg"''' name: Example Request samples-languages: - curl tags: - GovChecks /govchecks/v1/pe/govcheck: post: summary: 'GovChecks: Peru Govcheck' description: Verify a user's DNI and identity operationId: govchecks-peru-govcheck requestBody: content: application/json: schema: type: object required: - documentNumber - callbackUrl properties: documentNumber: type: string callbackUrl: type: string description: Webhook URL responses: '200': description: '200' content: application/json: examples: User Found: value: "{\n \"error\": null,\n \"data\": {\n \"firstName\": \"MARIA\",\n \ \ \"middleName\": \"ANTONELLA\",\n \"surname\": \"MONDRAGON\",\n \"secondSurname\"\ : \"ALBURQUEQUE\",\n \"dniNumber\": \"75870597\"\n }\n}" schema: type: object properties: error: {} data: type: object properties: firstName: type: string example: MARIA middleName: type: string example: ANTONELLA surname: type: string example: MONDRAGON secondSurname: type: string example: ALBURQUEQUE dniNumber: type: string example: '75870597' '201': description: '201' content: application/json: examples: DNI Number Not Found: value: "{\n \"error\": {\n \"type\": \"StepError\",\n \"code\": \"peruvianGovcheck.noResults\"\ ,\n \"message\": \"The DNI number was not found in the database\"\n }\n \"data\" :null\n}" '400': description: '400' content: application/json: examples: Bad DNI Number: value: "{\n \"error\": {\n \"type\": \"StepError\",\n \"code\": \"peruvianGovcheckc.notValidParams\"\ ,\n \"message\": \"DNI is not defined\"\n }\n \"data\" :null\n}" '503': description: '503' content: application/json: examples: Result: value: "{\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"system.serviceUnavailable\"\ ,\n \"message\": \"The service is unavailable\"\n },\n \"data\": null\n }\n}" deprecated: false x-readme: code-samples: - language: curl code: "curl --request POST \\\n --url https://api.getmati.com/govchecks/v1/pe/reniec \\\n --header 'Accept:\ \ application/json'\n --data-raw '{\n \"callbackUrl\": \"{{callback_URL}}\",\n \"documentNumber\"\ : \"123456789\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/pe/migration-institute: post: summary: 'GovChecks: Peru Migration Institute' description: Verify that a user has a valid immigration status in Peru operationId: govchecks-peru-migration-institute requestBody: content: application/json: schema: type: object required: - documentNumber - dateOfBirth - callbackUrl properties: documentNumber: type: string dateOfBirth: type: string format: date callbackUrl: type: string description: Webhook URL responses: '200': description: '200' content: application/json: examples: User Found: value: "{\n \"status\": 200,\n \"id\": \"peruvian-national-migration-institute\",\n \"error\": null,\n\ \ \"data\": {\n \"fullName\": \"DOE, JOHN\",\n \"dateOfBirth\": \"1990-01-01\",\n \"nationality\"\ : \"VENEZOLANA\",\n \"immigrationStatus\": \"ESPECIAL\",\n \"residentUntil\": \"2022-02-19\",\n\ \ \"dateOfExpiry\": \"2024-02-19\",\n \"dateOfIssue\": \"2021-02-19\"\n }\n \"timestamp\": \"\ 2020-11-17T18:36:57.198Z\"\n}" User Not Found: value: "{\n \"status\": 200,\n \"id\": \"peruvian-national-migration-institute\",\n \"error\": {\n \ \ \"type\": \"stepError\",\n \"code\": \"peruvianNationalMigrationInstitute.noResults\",\n \"message\"\ : \"The user was not found in the foreign immigration database\"\n },\n \"data\": null,\n \"timestamp\"\ : \"2020-11-17T18:36:57.198Z\"\n}" schema: type: object properties: status: type: integer example: 200 default: 0 id: type: string example: peruvian-national-migration-institute error: type: object properties: type: type: string example: stepError code: type: string example: peruvianNationalMigrationInstitute.noResults message: type: string example: The user was not found in the foreign immigration database data: {} timestamp: type: string example: '2020-11-17T18:36:57.198Z' deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/pe/migration-institute \\ \n--header\ \ 'Content-Type: application/json' \\ \n--header 'Authorization: Bearer token' \\ \n--data-raw '{\n\t\"documentNumber\"\ : \"00000000\",\n\t\"dateOfBirth\": \"1990-01-01\",\n\t\"callbackUrl\":\"{{callback URL}}\"\n }'" samples-languages: - curl tags: - GovChecks /govchecks/v1/pe/sunat: post: summary: 'GovChecks: Peru SUNAT' description: Verify that a user has valid Peruvian tax status operationId: govchecks-peru-sunat requestBody: content: application/json: schema: type: object required: - documentNumber - callbackUrl properties: documentNumber: type: string callbackUrl: type: string description: Webhook URL responses: '200': description: '200' content: application/json: examples: User Found: value: "{\n \"error\": null,\n \"data\": {\n \"fullName\": \"DOE JOHN\",\n \"documentNumber\": \"\ 00000000 \",\n \"RUC\": \"00000000000\",\n \"province\": \"ORIV. CONST. DEL CALLAO\",\n \"taxStatus\"\ : \"ACTIVO\",\n \"taxPayerType\": \"PERSONA NATURAL SIN NEGOCIO\",\n \"dateOfregistration\": \"\ 01/01/2010\",\n \"taxCondition\": \"HABIDO\",\n \"economicActivities\": [\n \"Principal - 9609\ \ - OTRAS ACTIVIDADES DE SERVICIOS PERSONALES N.C.P.\"\n ]\n }\n}" User Not Found: value: "{\n \"error\": {\n\t \"type\": \"stepError\",\n\t \"code\": \"peruvianSunat.notFound\",\n\ \t \"message\": \"No results were found in the SUNAT database\"\n\t},\n \"data\": null,\n }\n}" Service Unavailable: value: "{\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"system.serviceUnavailable\"\ ,\n \"message\": \"The SUNAT service is unavailable\"\n },\n \"data\": null\n }\n\ }" schema: type: object properties: error: {} data: type: object properties: fullName: type: string example: DOE JOHN documentNumber: type: string example: '00000000 ' RUC: type: string example: '00000000000' province: type: string example: ORIV. CONST. DEL CALLAO taxStatus: type: string example: ACTIVO taxPayerType: type: string example: PERSONA NATURAL SIN NEGOCIO dateOfregistration: type: string example: 01/01/2010 taxCondition: type: string example: HABIDO economicActivities: type: array items: type: string example: Principal - 9609 - OTRAS ACTIVIDADES DE SERVICIOS PERSONALES N.C.P. deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/pe/sunat\n --header 'Content-Type:\ \ application/json' \\\n --header 'Authorization: Bearer token' \\ \n --data-raw '{\n \"documentNumber\"\ : \"00000000\",\n \"callbackUrl\":\"https://some.callback.url\"}'" samples-languages: - curl tags: - GovChecks /govchecks/v1/ph/umid-ssn: post: summary: 'GovChecks: Philippines UMID/SSN' description: Verify a user's UMID/SSN against the Philippine UMID/SSN database via document number operationId: govchecks-philippines-umid-ssn requestBody: content: application/json: schema: type: object required: - documentNumber - callbackUrl properties: documentNumber: type: string description: 'Document number from the UMID. e.g: "0123-4567890-1"' callbackUrl: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"data\": {\n \"valid\": true,\n \"documentNumber\": \"0123-4567890-1\"\n },\n \"error\"\ : null\n}" Invalid Data: value: " \"data\": null,\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"philippineUmidSsn.notValidParams\"\ ,\n \"message\": \"The data passed appears to be invalid\"\n }" schema: type: object properties: data: type: object properties: valid: type: boolean example: true default: true documentNumber: type: string example: 0123-4567890-1 error: {} '500': description: '500' content: application/json: examples: Service Unavailable: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"philippineUmidSsn.serviceUnavailable\"\ ,\n \"message\": \"Service is unavailable\"\n }\n}" Internal Error: value: "{\n \"data\": null,\n \"error\": {\n \"type\": \"systemError\",\n \"code\": \"system.internalError\"\ ,\n \"message\": \"Internal error has occurred\"\n }\n}" schema: oneOf: - title: Service Unavailable type: object properties: data: {} error: type: object properties: type: type: string example: systemError code: type: string example: philippineUmidSsn.serviceUnavailable message: type: string example: Service is unavailable - title: Internal Error type: object properties: data: {} error: type: object properties: type: type: string example: systemError code: type: string example: system.internalError message: type: string example: Internal error has occurred deprecated: false x-readme: code-samples: - language: curl code: "curl --location 'https://api.prod.metamap.com/govchecks/v1/ph/umid-ssn' \\\n--header 'Content-Type: application/json'\ \ \\\n--header 'Authorization: Bearer {{TOKEN}}' \\\n--data '{\n \"documentNumber\": \"0123-4567890-1\",\n \ \ \"callbackUrl\": \"https://some.webhook.url\"\n}'" samples-languages: - curl tags: - GovChecks /govchecks/v1/uy/registro-civil: post: summary: 'GovChecks: Uruguay Registro Civil' description: Verify a user's national ID against the Uruguay DGREC database operationId: govchecks-uruguay-registro-civil requestBody: content: application/json: schema: type: object required: - documentNumber - callbackUrl properties: documentNumber: type: string description: Document number for a National ID callbackUrl: type: string metadata: type: string description: Use `metadata` to add internal references for your outputs/webhooks. default: '{ "user-defined-1": "string", "user-defined-2": "string" }' format: json responses: '200': description: '200' content: application/json: examples: Document Verified: value: "{\n \"data\": {\n \"firstName\": \"JOHN\",\n \"lastName\": \"DOE\",\n \"dateOfBirth\"\ : \"2001-01-01\",\n \"district\": \"Cerro Largo 1\",\n \"certificateNumber\": \"111\"\n },\n \"\ error\": null,\n \"metadata\": {\n \"user-defined-1\": \"string\",\n \"user-defined-2\": \"string\"\ \n }\n}" Full Name Mismatch: value: "{\n \"error\": {\n \"type\": \"StepError\",\n \"code\": \"uruguayRegistroCivil.fullNameMismatch\"\ ,\n \"message\": \"The name doesn't match to the name from the provider\"\n },\n \"data\":\ \ {\n \"firstName\": \"JOHN\",\n \"lastName\": \"DOE\",\n \"dateOfBirth\": \"2001-01-01\"\ ,\n \"district\": \"Cerro Largo 1\",\n \"certificateNumber\": \"111\"\n }\n \"metadata\"\ : {\n \"user-defined-1\": \"string\",\n \"user-defined-2\": \"string\"\n } \n}" schema: type: object properties: data: type: object properties: firstName: type: string example: JOHN lastName: type: string example: DOE dateOfBirth: type: string example: '2001-01-01' district: type: string example: Cerro Largo 1 certificateNumber: type: string example: '111' error: {} metadata: type: object properties: user-defined-1: type: string example: string user-defined-2: type: string example: string '204': description: '204' content: application/json: examples: Not Valid Params: value: "{\n \"error\": {\n \"type\": \"StepError\",\n \"code\": \"uruguayRegistroCivil.notValidParams\"\ ,\n \"message\": \"Invalid params\"\n }\n}" schema: type: object properties: error: type: object properties: type: type: string example: StepError code: type: string example: uruguayRegistroCivil.notValidParams message: type: string example: Invalid params '503': description: '503' content: application/json: examples: Service Unavailable: value: "{\n \"error\": {\n \"type\": \"govCheckError\",\n \"code\": \"argentinianRenaperPremium.serviceUnavailable\"\ ,\n \"message\": \"Uruguay Registro Civil service is unavailable\" \n },\n \"data\": null\n}" schema: type: object properties: error: type: object properties: type: type: string example: govCheckError code: type: string example: argentinianRenaperPremium.serviceUnavailable message: type: string example: Uruguay Registro Civil service is unavailable data: {} deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/govchecks/v1/uy/registro-civil' \\\n--header 'Content-Type:\ \ application/json' \\\n--header 'Authorization: Bearer token' \\\n--data-raw '{\n\t\t\"documentNumber\": \"12345678\"\ ,\n \"callbackUrl\":\"{{callbackUrl}}\"\n \"metadata\": {\n \"user-defined-1\": \"string\",\n \ \ \"user-defined-2\": \"string\"\n } \n }' " samples-languages: - curl tags: - GovChecks /backgroundchecks/v1/mx/background-buholegal: post: summary: 'Mexico: Court Records' description: Use this API to check for users for court records in Mexico. operationId: mexico-court-records requestBody: content: application/json: schema: type: object required: - firstName - firstSurname - secondSurname - curp - callbackUrl properties: firstName: type: string description: User's first name firstSurname: type: string description: User's first surname secondSurname: type: string description: User's second surname curp: type: string description: "User's Unique Population Registration Code (Clave \xDAnica de Registro de Poblaci\xF3n, CURP)" callbackUrl: type: string description: Callback URL to receive data. responses: '200': description: '200' content: application/json: examples: No Criminal Records Found: value: "{\n \"data\": {\n \"firstName\": \"JOHN\",\n \"firstSurname\": \"DOE\",\n \"lastSurname\"\ : \"DOE\",\n \"secondSurname\": \"DOE\",\n \"curp\": \"AAAA000000HCHLRN00\",\n \"dateOfBirth\"\ : \"01/01/2000\",\n \"age\": 22,\n \"gender\": \"Male\",\n \"status\": \"Accepted\",\n \"\ resource\": null,\n \"timestamp\": null,\n \"stepExtra\": [\n {\n \"query\": {\n \ \ \"nombre\": \"JOHN\",\n \"paterno\": \"DOE\",\n \"materno\": \"DOE\",\n \ \ \"persona\": \"fisica\",\n \"curp\": \"AAAA000000HCHLRN00\",\n \"estado\": \"\ nacional\",\n \"fecha_inicio\": null,\n \"fecha_fin\": null,\n \"detalle\"\ : true\n },\n \"numero_resultados\": 0,\n \"resultados\": [],\n \"homonimia\"\ : \"1\",\n \"validacion_curp\": {\n \"nombre\": \"JOHN\",\n \"paterno\": \"DOE\"\ ,\n \"materno\": \"DOE\",\n \"fecha_nacimiento\": \"01/01/2000\",\n \"sexo\"\ : \"HOMBRE\",\n \"entidad_nacimiento\": \"DISTRITO FEDERAL\",\n \"curp\": \"AAAA000000HCHLRN00\"\ \n },\n \"cedula_profesional\": []\n }\n ]\n },\n \"error\": null\n}" Single Match Found: value: "{\n \"data\": {\n \"firstName\": \"JOHN\",\n \"firstSurname\": \"DOE\",\n \"secondSurname\"\ : \"DOE\",\n \"curp\": \"AAAA000000HCHLRN00\",\n \"dateOfBirth\": \"01/01/2000\",\n \"age\":\ \ 29,\n \"gender\": \"Male\",\n \"status\": \"Rejected\",\n \"stepExtra\": {\n \"query\"\ : {\n \"nombre\": \"JOHN\",\n \"paterno\": \"DOE\",\n \"materno\": \"DOE\",\n \ \ \"persona\": \"fisica\",\n \"curp\": \"AAAA000000HCHLRN00\",\n \"estado\": \"nacional\"\ ,\n \"fecha_inicio\": null,\n \"fecha_fin\": null,\n \"detalle\": true\n },\n\ \ \"numero_resultados\": 1,\n \"resultados\": [\n {\n \"entidad\": \"Chihuahua\"\ ,\n \"expedientes\": [\n {\n \"expediente\": \"01040/2016\",\n \ \ \"actor\": \"JOHN DOE\",\n \"demandado\": \"JOHN DOE\",\n \"entidad\"\ : \"Chihuahua\",\n \"juzgado\": \"Morelos - Juzgado Quinto Familiar por Audiencias\",\n \ \ \"tipo\": \" Juicio Ordinario Familiar Alimentos\",\n \"fuero\": \"Com\xFA\ n\",\n \"fecha\": \"14-09-2017\",\n \"acuerdos\": [\n {\n \ \ \"acuerdo\": \"JOHN DOE DID X \",\n \"fecha\": \"14-09-2017\"\n \ \ },\n {\n \"acuerdo\": \"JOHN DOE DID Y\",\n \ \ \"fecha\": \"22-09-2017\"\n },\n {\n \"acuerdo\":\ \ \"JOHN DOE DID Z\",\n \"fecha\": \"06-10-2017\"\n }\n ]\n\ \ }\n ]\n }\n ],\n \"homonimia\": \"1\",\n \"validacion_curp\"\ : {\n \"nombre\": \"JOHN\",\n \"paterno\": \"DOE\",\n \"materno\": \"DOE\",\n \ \ \"fecha_nacimiento\": \"01/01/2000\",\n \"sexo\": \"HOMBRE\",\n \"entidad_nacimiento\"\ : \"CHIHUAHUA\",\n \"curp\": \"AAAA000000HCHLRN00\"\n },\n \"cedula_profesional\": []\n\ \ }\n },\n \"error\": {\n \"type\": \"backgroundCheckError\",\n \"code\": \"backgroundMexicanBuholegal.SingleResultFound\"\ ,\n \"message\": \"The user was found to have criminal records, please review this user before accepting\ \ / rejecting\"\n }\n}" Mutliple Matches Found: value: "{\n \"error\": {\n \"code\": \"background.ResultsFound\",\n \"message\": \"There were multiple\ \ matches with the information provided, and some of them have criminal records, please double check the\ \ user's information before accepting/rejecting\"\n },\n \"data\": {\n \"firstName\": \"JOHN\",\n\ \ \"curp\": \"AAAA000000HCHLRN00\",\n \"dateOfBirth\": \"2000-01-01\",\n \"age\": \"22\",\n \ \ \"gender\": \"Male\",\n \"status\": \"Rejected\",\n \"fullBackgroundCheck\": [\n {\n \ \ \"numero_resultados\": 1,\n \"resultados\": [\n {\n \"entidad\": \"\ Sonora\",\n \"expedientes\": [\n {\n \"expediente\": \"01801/2020\"\ ,\n \"actor\": \"JOHN DOE\",\n \"demandado\": \"JOHN DOE\",\n \ \ \"entidad\": \"Sonora\",\n \"juzgado\": \"Hermosillo - Juzgado Segundo de Primera\ \ Instancia Mercantil\",\n \"tipo\": \"\",\n \"fuero\": \"Com\xFAn\",\n\ \ \"fecha\": \"07-01-2021\",\n \"acuerdos\": [\n {\n \ \ \"acuerdo\": \"JOHN DOE DID X\",\n \"fecha\": \"07-01-2021\"\n \ \ },\n {\n \"acuerdo\": \"JOHN DOE DID Y\",\n \ \ \"fecha\": \"08-02-2021\"\n },\n {\n \ \ \"acuerdo\": \"JOHN DOE DID Z\",\n \"fecha\": \"10-02-2021\"\n \ \ }\n ]\n }\n ]\n }\n ],\n \"homonimia\"\ : 16,\n \"cedula_profesional\": \"[]\",\n \"query\": {\n \"nombre\": \"JOHN\",\n\ \ \"paterno\": \"DOE\",\n \"materno\": \"DOE\",\n \"persona\": \"fisica\",\n\ \ \"estado\": \"nacional\",\n \"fecha_inicio\": \"2019-01-01\",\n \"fecha_fin\"\ : \"2021-03-01\",\n \"detalle\": 1\n },\n \"validacion_curp.error\": \"El CURP\ \ no pudo ser validado. Hubo un error de conexion con el Registro Nacional de Poblaci\xF3n.\"\n }\n\ \ ]\n },\n \"timestamp\": \"2020-11-24T22:42:12.209Z\"\n}" schema: oneOf: - title: No Criminal Records Found type: object properties: data: type: object properties: firstName: type: string example: JOHN firstSurname: type: string example: DOE lastSurname: type: string example: DOE secondSurname: type: string example: DOE curp: type: string example: AAAA000000HCHLRN00 dateOfBirth: type: string example: 01/01/2000 age: type: integer example: 22 default: 0 gender: type: string example: Male status: type: string example: Accepted resource: {} timestamp: {} stepExtra: type: array items: type: object properties: query: type: object properties: nombre: type: string example: JOHN paterno: type: string example: DOE materno: type: string example: DOE persona: type: string example: fisica curp: type: string example: AAAA000000HCHLRN00 estado: type: string example: nacional fecha_inicio: {} fecha_fin: {} detalle: type: boolean example: true default: true numero_resultados: type: integer example: 0 default: 0 resultados: type: array items: type: object properties: {} homonimia: type: string example: '1' validacion_curp: type: object properties: nombre: type: string example: JOHN paterno: type: string example: DOE materno: type: string example: DOE fecha_nacimiento: type: string example: 01/01/2000 sexo: type: string example: HOMBRE entidad_nacimiento: type: string example: DISTRITO FEDERAL curp: type: string example: AAAA000000HCHLRN00 cedula_profesional: type: array items: type: object properties: {} error: {} - title: Single Match Found type: object properties: data: type: object properties: firstName: type: string example: JOHN firstSurname: type: string example: DOE secondSurname: type: string example: DOE curp: type: string example: AAAA000000HCHLRN00 dateOfBirth: type: string example: 01/01/2000 age: type: integer example: 29 default: 0 gender: type: string example: Male status: type: string example: Rejected stepExtra: type: object properties: query: type: object properties: nombre: type: string example: JOHN paterno: type: string example: DOE materno: type: string example: DOE persona: type: string example: fisica curp: type: string example: AAAA000000HCHLRN00 estado: type: string example: nacional fecha_inicio: {} fecha_fin: {} detalle: type: boolean example: true default: true numero_resultados: type: integer example: 1 default: 0 resultados: type: array items: type: object properties: entidad: type: string example: Chihuahua expedientes: type: array items: type: object properties: expediente: type: string example: 01040/2016 actor: type: string example: JOHN DOE demandado: type: string example: JOHN DOE entidad: type: string example: Chihuahua juzgado: type: string example: Morelos - Juzgado Quinto Familiar por Audiencias tipo: type: string example: ' Juicio Ordinario Familiar Alimentos' fuero: type: string example: "Com\xFAn" fecha: type: string example: 14-09-2017 acuerdos: type: array items: type: object properties: acuerdo: type: string example: 'JOHN DOE DID X ' fecha: type: string example: 14-09-2017 homonimia: type: string example: '1' validacion_curp: type: object properties: nombre: type: string example: JOHN paterno: type: string example: DOE materno: type: string example: DOE fecha_nacimiento: type: string example: 01/01/2000 sexo: type: string example: HOMBRE entidad_nacimiento: type: string example: CHIHUAHUA curp: type: string example: AAAA000000HCHLRN00 cedula_profesional: type: array items: type: object properties: {} error: type: object properties: type: type: string example: backgroundCheckError code: type: string example: backgroundMexicanBuholegal.SingleResultFound message: type: string example: The user was found to have criminal records, please review this user before accepting / rejecting - title: Mutliple Matches Found type: object properties: error: type: object properties: code: type: string example: background.ResultsFound message: type: string example: There were multiple matches with the information provided, and some of them have criminal records, please double check the user's information before accepting/rejecting data: type: object properties: firstName: type: string example: JOHN curp: type: string example: AAAA000000HCHLRN00 dateOfBirth: type: string example: '2000-01-01' age: type: string example: '22' gender: type: string example: Male status: type: string example: Rejected fullBackgroundCheck: type: array items: type: object properties: numero_resultados: type: integer example: 1 default: 0 resultados: type: array items: type: object properties: entidad: type: string example: Sonora expedientes: type: array items: type: object properties: expediente: type: string example: 01801/2020 actor: type: string example: JOHN DOE demandado: type: string example: JOHN DOE entidad: type: string example: Sonora juzgado: type: string example: Hermosillo - Juzgado Segundo de Primera Instancia Mercantil tipo: type: string example: '' fuero: type: string example: "Com\xFAn" fecha: type: string example: 07-01-2021 acuerdos: type: array items: type: object properties: acuerdo: type: string example: JOHN DOE DID X fecha: type: string example: 07-01-2021 homonimia: type: integer example: 16 default: 0 cedula_profesional: type: string example: '[]' query: type: object properties: nombre: type: string example: JOHN paterno: type: string example: DOE materno: type: string example: DOE persona: type: string example: fisica estado: type: string example: nacional fecha_inicio: type: string example: '2019-01-01' fecha_fin: type: string example: '2021-03-01' detalle: type: integer example: 1 default: 0 validacion_curp.error: type: string example: "El CURP no pudo ser validado. Hubo un error de conexion con el Registro Nacional\ \ de Poblaci\xF3n." timestamp: type: string example: '2020-11-24T22:42:12.209Z' '503': description: '503' content: application/json: examples: Result: value: "{\n \"error\": {\n \"code\": \"system.serviceUnavailable\",\n \"message\": \"The Background\ \ Check service is currently unavailable, please try again later\"\n },\n \"data\": null,\n \"timestamp\"\ : \"2020-11-24T22:42:12.209Z\"\n}" schema: type: object properties: error: type: object properties: code: type: string example: system.serviceUnavailable message: type: string example: The Background Check service is currently unavailable, please try again later data: {} timestamp: type: string example: '2020-11-24T22:42:12.209Z' deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/backgroundchecks/v1/mx/background-buholegal' \\\n\ --header 'Authorization: Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"\ firstName\": \"\",\n \"firstSurname\": \"\",\n \"secondSurname\": \"\"\ ,\n \"curp\": \"ABCD012345EFGHIJ67\",\n \"callbackUrl\": \"https://webhook.site/\"\n}'" samples-languages: - curl tags: - Background Checks /safety/v1/checks/phone/otp: post: summary: Phone Ownership description: This API sends an OTP through SMS to verify ownership operationId: phone-ownership requestBody: content: application/json: schema: type: object required: - callbackUrl - locale - recipient - senderName properties: callbackUrl: type: string description: Callback URL to receive webhooks. locale: type: string description: 'Location of search. Currently allows one of the following values: `"en_US"`, `"es_MX"`, `""`, and `null`.' recipient: type: string description: Country code and phone number. Must be entered as a single number with no delimiters, such as "-" or "." or spaces. senderName: type: string description: User name associated with the SMS number. metadata: type: string description: Metadata to be sent to a webhook (`callbackUrl`) default: '{ "user-defined-1" : "abcde", "user-defined-2" : "12345" }' format: json responses: '200': description: '200' content: text/plain: examples: Result: value: "{\n \"error\": null,\n \"data\": {\n \"confirmationCode\": \"8844\"\n },\n \"metadata\":\ \ {\n \t\"user_defined\": \"id00000\"\n }\n}" schema: type: object properties: error: {} data: type: object properties: confirmationCode: type: string example: '8844' metadata: type: object properties: user_defined: type: string example: id00000 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: "POST https://api.getmati.com/safety/v1/checks/phone/otp \n-H 'Content-Type: application/json' \\\n-H \"Authorization:\ \ Bearer \" \\\n{\n \"recipient\": \"000000000000\",\n \"callbackUrl\": \"https://some.webhook.url\"\ ,\n \"locale\": \"es_MX\",\n \"senderName\": \"Acme Corporation\",\n \t \"metadata\": { \n \t\"user_defined\"\ : \"id00000\"\n \t}\n}" samples-languages: - curl tags: - Phone Checks /safety/v1/checks/phone/risk: post: summary: Phone Risk description: Use this API to assess a user's behavioral risk through their phone number operationId: phone-risk requestBody: content: application/json: schema: type: object required: - recipient - callbackUrl properties: recipient: type: string description: User's phone number. Enter the phone number as a numerical string with no delimiters, such as ".", "(", ")", or "-". callbackUrl: type: string description: Callback URL to receive the risk assessment score. metadata: type: string description: Metadata to be sent to a webhook (`callbackUrl`) default: '{ "user-defined-1" : "abcde", "user-defined-2" : "12345" }' format: json responses: '200': description: '200' content: application/json: examples: Very High Risk: value: "{\n \"error\": null,\n \"data\": {\n \"phoneNumber\": \"00000000000\",\n \"countryCode\"\ : \"7\",\n \"phoneType\": \"Mobile\",\n \"phoneTypeStatus\": \"Allowed\",\n \"riskLevel\": \"\ very-high\",\n \"riskInsights\": [\n {\n \"name\": \"high-risk irregular activity\",\n\ \ \"description\": \"Highest-risk category, based on past behavior.\",\n \"impact\": \"\ Negative\",\n \"type\": \"Category\"\n },\n {\n \"name\": \"no range activity\"\ ,\n \"description\": \"Very little activity, or none at all, for a risky range that this number\ \ belongs to over the past 90 days. Also returned if the number does not belong to a risky range.\",\n\ \ \"impact\": \"Positive\",\n \"type\": \"Automation to human activity\"\n },\n \ \ {\n \"name\": \"no activity\",\n \"description\": \"Very little activity, or none at\ \ all, was ever observed on this number. Very short tenure. Cannot classify.\",\n \"impact\": \"\ Neutral\",\n \"type\": \"Human to human activity\"\n }\n ],\n \"riskScore\": 80,\n \ \ \"maxPossibleRiskScore\": 100,\n \"recommendation\": \"block\",\n \"timezone\": \"+2\",\n \ \ \"lineType\": \"MOBILE\",\n \"carrier\": \"Vimpel Communications\",\n \"location\": {\n \ \ \"city\": \"Moscow\",\n \"state\": null,\n \"zip\": null,\n \"metroCode\": null,\n \ \ \"county\": null,\n \"country\": \"Russia\"\n }\n },\n \"metadata\": { \n \t\"user_defined\"\ : \"id00000\"\n } \n}" schema: type: object properties: error: {} data: type: object properties: phoneNumber: type: string example: '00000000000' countryCode: type: string example: '7' phoneType: type: string example: Mobile phoneTypeStatus: type: string example: Allowed riskLevel: type: string example: very-high riskInsights: type: array items: type: object properties: name: type: string example: high-risk irregular activity description: type: string example: Highest-risk category, based on past behavior. impact: type: string example: Negative type: type: string example: Category riskScore: type: integer example: 80 default: 0 maxPossibleRiskScore: type: integer example: 100 default: 0 recommendation: type: string example: block timezone: type: string example: '+2' lineType: type: string example: MOBILE carrier: type: string example: Vimpel Communications location: type: object properties: city: type: string example: Moscow state: {} zip: {} metroCode: {} county: {} country: type: string example: Russia metadata: type: object properties: user_defined: type: string example: id00000 '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/safety/v1/checks/phone/risk' \\\n--header 'Authorization:\ \ Bearer ' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\"recipient\": \"000000000000\"\ ,\n\"callbackUrl\": \"https://some.webhook.url\",\n\"metadata\": {\t\"user_defined\": \"id00000\" }\n}'" samples-languages: - curl tags: - Phone Checks /v2/verifications/{id}: get: summary: Retrieve Webhook Resource Data description: Use this API to retrieve Webhook Resource Data operationId: retrieve-webhook-resource-data-1 parameters: - name: id in: path description: The `id` is in the successful response to a [Verification Creation](https://docs.metamap.com/reference/verification-creation) request schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Successful Webhook response: value: "{\n \"expired\": false,\n \"deviceFingerprint\": {\n \"ua\": \"Mozilla/5.0 (Linux; Android\ \ 10; SM-M305M) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.116 Mobile Safari/537.36\",\n\ \ \"browser\": {\n \"name\": \"Chrome\",\n \"version\": \"79.0.3945.116\",\n \"major\"\ : \"79\"\n },\n \"engine\": {\n \"name\": \"WebKit\",\n \"version\": \"537.36\"\n },\n\ \ \"os\": {\n \"name\": \"Android\",\n \"version\": \"10\"\n },\n \"device\": {\n \ \ \"vendor\": \"Samsung\",\n \"model\": \"SM-M305M\",\n \"type\": \"mobile\"\n }\n },\n\ \ \"identity\": {\n \"status\": \"reviewNeeded\"\n },\n \"steps\": [\n {\n \"status\": 200,\n\ \ \"id\": \"selfie\",\n \"data\": {\n \"selfiePhotoUrl\": \"https://media.getmati.com/media/eyJhbGciOiJIUzI1NiIsInR5cC...\"\ \n },\n \"error\": null\n }, {\n \"status\": 200,\n \"id\": \"ip-validation\"\ ,\n \"data\": {\n \"country\": \"Mexico\",\n \"countryCode\": \"MX\",\n \ \ \"region\": \"Chihuahua\",\n \"regionCode\": \"CHH\",\n \"city\": \"\ Ciudad Ju\xE1rez\",\n \"zip\": 32472,\n \"latitude\": 1.713,\n \"longitude\"\ : 106.39,\n \"safe\": false\n }\n }\n ],\n \"documents\": [\n {\n \"country\"\ : \"MX\",\n \"type\": \"national-id\",\n \"steps\": [\n {\n \"status\": 200,\n\ \ \"id\": \"mexican-curp-validation\",\n \"error\": {\n \"type\": \"StepError\"\ ,\n \"code\": \"curp.invalid\",\n \"message\": \"CURP number is invalid\"\n \ \ }\n },\n {\n \"status\": 200,\n \"id\": \"mexican-ine-validation\"\ ,\n \"error\": {\n \"type\": \"StepError\",\n \"code\": \"ine.notEnoughParams\"\ ,\n \"message\": \"Not enough params to get ine data\"\n }\n },\n {\n\ \ \"status\": 200,\n \"id\": \"template-matching\",\n \"error\": {\n \ \ \"type\": \"StepError\",\n \"code\": \"templateMatching.noMatchFound\",\n \ \ \"message\": \"Document did not match any valid template\"\n }\n },\n {\n \ \ \"status\": 200,\n \"id\": \"facematch\",\n \"error\": {\n \"type\"\ : \"LegacyError\",\n \"code\": \"legacy.error\",\n \"message\": \"The face did not\ \ match the document\"\n }\n },\n {\n \"status\": 200,\n \"id\"\ : \"document-reading\",\n \"error\": null,\n \"data\": {\n \"fullName\":\ \ {\n \"value\": null,\n \"label\": \"Name\"\n },\n \"\ address\": {\n \"value\": null,\n \"label\": \"Address\"\n },\n \ \ \"documentNumber\": {\n \"value\": null,\n \"label\": \"Document\ \ Number\"\n },\n \"dateOfBirth\": {\n \"value\": null,\n \ \ \"label\": \"Day of Birth\",\n \"format\": \"date\"\n },\n \"\ expirationDate\": {\n \"value\": null,\n \"label\": \"Date of Expiration\",\n\ \ \"format\": \"date\"\n },\n \"cde\": {\n \"value\":\ \ null,\n \"label\": \"Elector Key\"\n },\n \"curp\": {\n \ \ \"value\": null,\n \"label\": \"CURP\"\n },\n \"ne\": {\n \ \ \"value\": null,\n \"label\": \"Emission Number\"\n },\n \ \ \"ocrNumber\": {\n \"value\": null,\n \"label\": \"OCR Number\"\n \ \ }\n }\n },\n {\n \"status\": 200,\n \"id\": \"alteration-detection\"\ ,\n \"error\": {\n \"type\": \"LegacyError\",\n \"code\": \"legacy.error\"\ ,\n \"message\": \"Document is considered tempered\"\n }\n },\n {\n\ \ \"status\": 200,\n \"id\": \"watchlists\",\n \"error\": {\n \"\ type\": \"LegacyError\",\n \"code\": \"legacy.error\",\n \"message\": \"No data\ \ to extract information\"\n }\n }\n ],\n \"fields\": {\n \"fullName\"\ : {\n \"value\": null,\n \"label\": \"Name\"\n },\n \"address\": {\n \ \ \"value\": null,\n \"label\": \"Address\"\n },\n \"documentNumber\":\ \ {\n \"value\": null,\n \"label\": \"Document Number\"\n },\n \"dateOfBirth\"\ : {\n \"value\": null,\n \"label\": \"Day of Birth\",\n \"format\": \"date\"\ \n },\n \"expirationDate\": {\n \"value\": null,\n \"label\": \"Date of\ \ Expiration\",\n \"format\": \"date\"\n },\n \"cde\": {\n \"value\":\ \ null,\n \"label\": \"Elector Key\"\n },\n \"curp\": {\n \"value\": null,\n\ \ \"label\": \"CURP\"\n },\n \"ne\": {\n \"value\": null,\n \"\ label\": \"Emission Number\"\n },\n \"ocrNumber\": {\n \"value\": null,\n \ \ \"label\": \"OCR Number\"\n }\n },\n \"photos\": [\n \"https://media.getmati.com/media/eyJhbGciOiJIUzI1NiIs...\"\ ,\n \"https://media.getmati.com/media/eyJhbGciOiJIUzI1NiIs...\"\n ]\n }\n ],\n \"hasProblem\"\ : true,\n \"computed\": {\n \"age\" : {\n \"data\" : 33\n },\n \"isDocumentExpired\" :\ \ {\n \"data\" : {\n \"national-id\" : false,\n \"passport\": true,\n \"proof-of-residency\"\ : null\n }\n }\n },\n \"id\": \"{{_id}}\"\n}" schema: type: object properties: expired: type: boolean example: false default: true deviceFingerprint: type: object properties: ua: type: string example: Mozilla/5.0 (Linux; Android 10; SM-M305M) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.116 Mobile Safari/537.36 browser: type: object properties: name: type: string example: Chrome version: type: string example: 79.0.3945.116 major: type: string example: '79' engine: type: object properties: name: type: string example: WebKit version: type: string example: '537.36' os: type: object properties: name: type: string example: Android version: type: string example: '10' device: type: object properties: vendor: type: string example: Samsung model: type: string example: SM-M305M type: type: string example: mobile identity: type: object properties: status: type: string example: reviewNeeded steps: type: array items: type: object properties: status: type: integer example: 200 default: 0 id: type: string example: selfie data: type: object properties: selfiePhotoUrl: type: string example: https://media.getmati.com/media/eyJhbGciOiJIUzI1NiIsInR5cC... error: {} documents: type: array items: type: object properties: country: type: string example: MX type: type: string example: national-id steps: type: array items: type: object properties: status: type: integer example: 200 default: 0 id: type: string example: mexican-curp-validation error: type: object properties: type: type: string example: StepError code: type: string example: curp.invalid message: type: string example: CURP number is invalid fields: type: object properties: fullName: type: object properties: value: {} label: type: string example: Name address: type: object properties: value: {} label: type: string example: Address documentNumber: type: object properties: value: {} label: type: string example: Document Number dateOfBirth: type: object properties: value: {} label: type: string example: Day of Birth format: type: string example: date expirationDate: type: object properties: value: {} label: type: string example: Date of Expiration format: type: string example: date cde: type: object properties: value: {} label: type: string example: Elector Key curp: type: object properties: value: {} label: type: string example: CURP ne: type: object properties: value: {} label: type: string example: Emission Number ocrNumber: type: object properties: value: {} label: type: string example: OCR Number photos: type: array items: type: string example: https://media.getmati.com/media/eyJhbGciOiJIUzI1NiIs... hasProblem: type: boolean example: true default: true computed: type: object properties: age: type: object properties: data: type: integer example: 33 default: 0 isDocumentExpired: type: object properties: data: type: object properties: national-id: type: boolean example: false default: true passport: type: boolean example: true default: true proof-of-residency: {} id: type: string example: '{{_id}}' '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false x-readme: code-samples: - language: curl code: 'curl --location --request GET ''https://api.getmati.com/v2/verifications/'' \ --header ''Authorization: Bearer ''' samples-languages: - curl tags: - Webhooks /v2/identities/{identity}/send-input: post: summary: Send Inputs description: Use this API to send documents, selfies, videos, or other identifying information operationId: send-inputs parameters: - name: identity in: path description: The identity is in the successful response to a Verification Creation request schema: type: string required: true - name: Content-Type in: header required: true schema: type: string default: multipart/form-data requestBody: content: application/json: schema: type: object properties: inputs: type: object required: - inputType properties: inputType: type: string description: User input type group: type: integer description: Index of verificationSteps with given inputType in merchant configurations. Each document must have a unique group number, starting from 0. MetaMap-supported documents must precede custom documents. format: int32 data: type: object required: - filename properties: type: type: string description: For a MetaMap-supported document, the type of document, (driving-license, national-id, passport, proof-of-residency). For a selfie, selfie-photo. For a liveness video, selfie-video For a custom document, use the webhook label name you defined when you added the Custom Document merit to your metamap country: type: string description: Country code. Used only for MetaMap-supported documents to specify the document's country of issue. Omit this parameter for custom documents. Uses ISO 2 codes. region: type: string description: Used only to verify users in the United States. For non-US users, leave blank (example, ""). Refers to the user's state of residency (for example, "AL" for "Alabama"). Uses the US Postal Service state abbreviations page: type: string description: The document's page side. 1-sided documents require only the front 2-sided documents can be uploaded as two separate files (front and back) 2-sided Custom documents can be uploaded as 2 separate image files (front and back) or as a single *.pdf file (multi) Custom documents with >2 sides must upload a single *.pdf file (multi) filename: type: string description: The name of the file being uploaded. document: type: string description: MetaMap-supported documents only. Location of file to upload. format: binary custom-document: type: string description: Custom documents only. Location of file to upload. format: binary responses: '201': description: '201' content: application/json: examples: Successful Response, Fully Validated: value: "[\n {\n \"data\": {\n \"inputType\": \"selfie-photo\",\n \"type\"\ : \"selfie-photo\",\n \"filename\": \"selfie.png\"\n },\n \"result\": true\n\ \ },\n {\n \"data\": {\n \"inputType\": \"document-photo\",\n \"type\"\ : \"national-id\",\n \"country\": \"MX\",\n \"page\": \"front\",\n \"\ filename\": \"INE-front.jpg\"\n },\n \"result\": true\n },\n {\n \"data\":\ \ {\n \"inputType\": \"document-photo\",\n \"type\": \"national-id\",\n \ \ \"country\": \"MX\",\n \"page\": \"back\",\n \"filename\": \"INE-back.jpg\"\ \n },\n \"result\": true\n }\n]" Successful Response, Partial Validation: value: "[\n {\n \"data\": {\n \"inputType\": \"selfie-photo\",\n \"type\"\ : \"selfie-photo\",\n \"filename\": \"selfie.png\"\n },\n \"error\": {\n \ \ \"type\": \"ValidationError\",\n \"code\": \"selfiePhoto.noFace\"\n }\n \ \ },\n {\n \"data\": {\n \"inputType\": \"document-photo\",\n \"type\"\ : \"national-id\",\n \"country\": \"MX\",\n \"page\": \"front\",\n \"\ filename\": \"INE-front.jpg\"\n },\n \"result\": true\n },\n {\n \"data\":\ \ {\n \"inputType\": \"document-photo\",\n \"type\": \"national-id\",\n \ \ \"country\": \"MX\",\n \"page\": \"back\",\n \"filename\": \"INE-back.jpg\"\ \n },\n \"result\": true\n }\n]" schema: oneOf: - title: Successful Response, Fully Validated type: array items: type: object properties: data: type: object properties: inputType: type: string example: selfie-photo type: type: string example: selfie-photo filename: type: string example: selfie.png result: type: boolean example: true default: true - title: Successful Response, Partial Validation type: array items: type: object properties: data: type: object properties: inputType: type: string example: selfie-photo type: type: string example: selfie-photo filename: type: string example: selfie.png error: type: object properties: type: type: string example: ValidationError code: type: string example: selfiePhoto.noFace '400': description: '400' content: application/json: examples: Error In The Input Parameters: value: "{\n \"code\": 400,\n \"message\": \"No input strategy found for document-photo\"\n}" Bad Input Structure: value: "{\n \"code\": 400,\n \"message\": \"Invalid structure of request body\",\n \"name\": \"MoleculerError\"\ \n}" schema: oneOf: - title: Error In The Input Parameters type: object properties: code: type: integer example: 400 default: 0 message: type: string example: No input strategy found for document-photo - title: Bad Input Structure type: object properties: code: type: integer example: 400 default: 0 message: type: string example: Invalid structure of request body name: type: string example: MoleculerError deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/v2/identities/{{identity}}/send-input' \\\n--header\ \ 'Content-Type: multipart/form-data' \\\n--header 'Authorization: Bearer {{access_token}}' \\\n--form 'inputs=[\n\ \ {\n \"inputType\": \"document-photo\",\n \"group\": 0,\n \"data\": {\n \"type\": \"driving-license\"\ ,\n \"country\": \"MX\",\n \"page\": \"front\",\n \"filename\": \"MX_NI_FRONT.jpg\"\n }\n },\n\ \ {\n \"inputType\": \"document-photo\",\n \"group\": 0,\n \"data\": {\n \"type\": \"driving-license\"\ ,\n \"country\": \"MX\",\n \"page\": \"back\",\n \"filename\": \"MX_NI_BACK.jpg\"\n }\n },\n\ \ {\n \"inputType\": \"document-photo\",\n \"group\": 1,\n \"data\": {\n \"type\": \"passport\"\ ,\n \"country\": \"MX\",\n \"page\": \"front\",\n \"filename\": \"MX_PASSPORT.jpg\"\n }\n \ \ {\n \"inputType\": \"document-photo\",\n \"group\": 2,\n \"data\": {\n \"type\": \"proof-of-residency\"\ ,\n \"country\": \"MX\",\n \"page\": \"front\",\n \"filename\": \"proof-of-residence.png\"\n \ \ }\n },\n {\n \"inputType\": \"selfie-photo\",\n \"data\": {\n \"type\": \"selfie-photo\",\n \ \ \"filename\": \"selfie-photo.jpg\"\n }\n }\n]' \\\n--form 'document=@/C:/PATH_TO_FILE/MX_NI_FRONT.jpg'\ \ \\\n--form 'document=@/C:/PATH_TO_FILE/MX_NI_BACK.jpg' \\\n--form 'document=@/C:/PATH_TO_FILE/MX_PASSPORT.jpg'\ \ \\\n--form 'document=@/C:/PATH_TO_FILE/proof-of-residence.png' \\\n--form 'selfie=@/C:/PATH_TO_FILE/selfie-photo.jpg'" name: Driving License + Passport + Proof of Residency + Selfie - language: curl code: "curl --location --request POST 'https://api.getmati.com/v2/identities/{{_id}}/send-input' \\\n--header 'Content-Type:\ \ multipart/form-data' \\\n--header 'Authorization: Bearer {{access_token}}' \\\n--form 'inputs=[ \n {\"inputType\"\ :\"document-photo\",\"group\":0, \n \"data\":{\"type\":\"national-id\",\"country\":\"BR\",\"region\":\"\ \",\"page\":\"front\",\"filename\":\"43_front.jpg\"}}, \n {\"inputType\":\"document-photo\",\"group\":0, \n\ \ \"data\":{\"type\":\"national-id\",\"country\":\"BR\",\"region\":\"\",\"page\":\"back\",\"filename\"\ :\"44_back.jpg\"}} \n ]' \n--form 'document=@/C:/PATH_TO_FILE/43_front.jpg' \n--form 'document=@/C:/PATH_TO_FILE/44_back.jpg'" name: National ID - language: curl code: "curl --location --request POST 'https://api.getmati.com/v2/identities/{{_id}}/send-input' \\\n--header 'Content-Type:\ \ multipart/form-data' \\\n--header 'Authorization: Bearer {{access_token}}' \\\n--form 'inputs=[\n {\n \"\ inputType\": \"document-photo\",\n \"group\": 0,\n \"data\": {\n \"type\": \"national-id\",\n \ \ \"country\": \"US\",\n \"region\" : \"CA\",\n \"page\": \"front\",\n \"filename\": \"US_CA_DL_FRONT.jpg\"\ \n }\n },\n {\n \"inputType\": \"document-photo\",\n \"group\": 0,\n \"data\": {\n \"type\"\ : \"national-id\",\n \"country\": \"US\",\n \"region\" : \"CA\",\n \"page\": \"back\",\n \"\ filename\": \"US_CA_DL_BACK.jpg\"\n }\n },\n {\n \"inputType\": \"selfie-video\",\n \"data\": {\n\ \ \"filename\": \"Liveness_video.mp4\"\n }\n }\n]' \\\n--form 'document=@/C:/PATH_TO_FILE/US_CA_DL_FRONT.jpg'\ \ \\\n--form 'document=@/C:/PATH_TO_FILE/US_CA_DL_BACK.jpg' \\\n--form 'video=@/C:/PATH_TO_FILE/Liveness_video.mp4'" name: National ID + Selfie Video - language: curl code: "curl --location --request POST 'https://api.getmati.com/v2/identities/{id}/send-input' \\\n--header 'Content-Type:\ \ x-www-form-urlencoded' \\\n--header 'Authorization: Bearer {{access_token}}' \\\n--form 'inputs=[\n {\n \"\ inputType\":\"custom-document-photo\",\n \"group\":0,\n \"data\":{\n \"type\":\"custom-birth-certificate\"\ ,\n \"page\":\"front\",\n \"filename\":\"birth_front.jpg\"\n }\n },\n {\n \"inputType\":\"custom-document-photo\"\ ,\n \"group\":0,\n \"data\":{\n \"type\":\"custom-birth-certificate\",\n \"page\":\"back\",\n \"filename\"\ :\"birth_back.jpg\"\n }\n }\n]' \\\n--form 'custom-document=@/C:/PATH_TO_FILE/birth_front.jpg' \\\n--form\ \ 'custom-document=@/C:/PATH_TO_FILE/birth_back.jpg' \\\n \n " name: Custom Document - Birth Certificate - language: curl code: "curl --location --request POST 'https://api.getmati.com/v2/identities/{id}/send-input' \\\n--header 'Authorization:\ \ Bearer {{TOKEN}}' \\\n--form 'document=@\"//co-nid-front.png\"' \\\n--form 'document=@\"//co-nid-back.png\"\ ' \\\n--form 'inputs=[\n {\n \"inputType\":\"document-photo\",\n \"group\":0,\n \"data\":\n \ \ {\n \"type\":\"national-id\",\n \"country\":\"CO\",\n \"page\":\"front\",\n \"\ filename\":\"co-nid-front.png\"\n }\n },\n {\n \"inputType\":\"document-photo\",\n \"group\"\ :0,\n \"data\":\n {\n \"type\":\"national-id\",\n \"country\":\"CO\",\n \"page\"\ :\"back\",\n \"filename\":\"co-nid-back.png\"\n }\n },\n {\n \"inputType\":\"custom-document-photo\"\ ,\n \"group\":1,\n \"data\":\n {\n \"type\":\"custom-dummy-doc\",\n \"page\":\"multi\"\ ,\"filename\":\"dummy-doc.pdf\"\n }\n }\n]' \\\n--form 'custom-document=@\"//dummy-doc.pdf\"'" name: National ID + Custom Document samples-languages: - curl tags: - Verifications /v2/verifications/{verification_id}/inputs/document-photo/skip: put: summary: Skip Verification Upload Wait Time description: Use this API to skip the wait time when uploading the back of a document operationId: skip-verification-upload parameters: - name: x-mati-app in: header description: platform=web_desktop; version=22.2.10 required: true schema: type: string - name: verification_id in: path description: The ID returned by the Start Verification endpoint. schema: type: string required: true deprecated: false x-readme: code-samples: - language: curl code: 'curl --location --request POST ''https://api.getmati.com/verifications/{verification_id}/inputs/document-photo/skip/'' \ -H ''x-mati-app: platform=web_desktop; version=22.2.10'' \ -H "Authorization: Bearer " \ ' name: REQUEST samples-languages: - curl tags: - Verifications /v2/verifications: post: summary: Start Verification description: Use this endpoint to create a new user verification or reverify an existing user. operationId: start-verification parameters: - name: x-forwarded-for in: header description: 'WARNING: This header is only used for demonstration purposes on this site and is not necessary when using the MetaMap SDKs or tools such as Postman.' required: true schema: type: string requestBody: content: application/json: schema: type: object required: - flowId properties: flowId: type: string description: Your flowId can be found in the Metamap dashboard under "Integrations". metadata: type: string description: Use the metadata parameter to add internal references. default: '{ "user-defined-1" : "abcde", "user-defined-2" : "12345" }' format: json responses: '200': description: '200' content: application/json: examples: New User Verified: value: "{\n \"documents\": [],\n \"expired\": false,\n \"flow\": {\n \"id\": \"\"\ ,\n \"name\": \"\"\n },\n \"identity\": \"\",\n \"inputs\"\ : [\n {\n \"id\": \"connection-data\",\n \"status\": 200,\n \"optional\": false\n \ \ },\n {\n \"id\": \"document-photo\",\n \"status\": 0,\n \"group\": 0\n }\n ]," Existing User Verified: value: "{\n \"documents\": [],\n \"expired\": false,\n \"flow\": {\n \"id\": \"\"\ ,\n \"name\": \"API_re_verification\"\n },\n \"identity\": \"\",\n \"\ inputs\": [\n {\n \"id\": \"connection-data\",\n \"status\": 200,\n \"optional\": false\n\ \ },\n {\n \"id\": \"selfie-photo\",\n \"status\": 0\n }\n ],\n \"metadata\": {\n\ \ \"name\": \"re-verification\"\n },\n \"steps\": [\n {\n \"status\": 0,\n \"id\": \"\ re-facematch\"\n },\n {\n \"status\": 0,\n \"id\": \"selfie\"\n }\n ],\n \"id\":\ \ \" name: type: string example: API_re_verification identity: type: string example: inputs: type: array items: type: object properties: id: type: string example: connection-data status: type: integer example: 200 default: 0 optional: type: boolean example: false default: true metadata: type: object properties: name: type: string example: re-verification steps: type: array items: type: object properties: status: type: integer example: 0 default: 0 id: type: string example: re-facematch id: type: string example: \" \\\n-d '{\n \"flowId\": \"\"\ ,\n \"metadata\": {\n \"user\": \"JOHN DOE\",\n \"id\": \"123e4567-e89b-12d3-a456-426614174000\"\ \n }\n }'" name: Create Verification - language: curl code: "curl --location --request POST 'https://api.prod.metamap.com/v2/verifications' \\\n-H 'Content-Type: application/json'\ \ \\\n-H \"Authorization: Bearer \" \\\n-d '{ \n \"flowId\": \"\"\ ,\n \"identityId\": \"\",\n \"metadata\": {\n \"name\": \"test-re-verification\"\ \n }\n}" name: Reverify User samples-languages: - curl tags: - Verifications /v2/verifications/{verificationId}/status: put: summary: Update Verification Status description: '' operationId: update-verification-status parameters: - name: verificationId in: path description: Unique string assigned to a user's verification status schema: type: string required: true requestBody: content: application/json: schema: type: object required: - status properties: status: type: string description: '`data-raw` body. Status values can be one of the following: `deleted`, `pending`, `rejected`, `reviewNeeded`, `reviewRunning`, `running`, `postponed`, `verified`' responses: '200': description: '200' content: application/json: examples: Success: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Invalid status movement: value: '{}' schema: type: object properties: {} '404': description: '404' content: text/plain: examples: Verification not found: value: '{}' schema: type: object properties: {} '500': description: '500' content: text/plain: examples: Unexpected error: value: '{}' schema: type: object properties: {} deprecated: false tags: - Verifications /safety/v1/upload/watchlists/file: post: summary: Upload a Custom Watchlist description: Use this API to upload a custom watchlist operationId: upload-custom-watchlist requestBody: content: application/json: schema: type: object required: - watchlistId - callbackUrl - file properties: watchlistId: type: string csvSeparator: type: string description: Specify the separating character between your watchlist entries. default: ; callbackUrl: type: string file: type: string description: List of custom watchlist entries. The file must use a `*.csv` extension. format: binary responses: '202': description: '202' content: application/json: examples: Successful Request: value: '{}' schema: type: object properties: {} '400': description: '400' content: application/json: examples: Invalid Parameters: value: "{\n \"code\": 400,\n \"message\": \": should have required property 'callbackUrl'\",\n \"type\"\ : \"safetyApi.invalidParams\",\n}" The Number Of Files Exceeds Limit: value: "{\n \"code\": 400,\n \"message\": \"Files limit exceeded\",\n \"name\": \"MoleculerError\"\n}" schema: type: object properties: code: type: integer example: 400 default: 0 message: type: string example: Files limit exceeded name: type: string example: MoleculerError '413': description: '413' content: application/json: examples: Result: value: "{\n \"name\": \"MoleculerError\",\n \"message\": \"File size limit exceeded\",\n \"code\": 413\n\ }" schema: type: object properties: name: type: string example: MoleculerError message: type: string example: File size limit exceeded code: type: integer example: 413 default: 0 '500': description: '500' content: text/plain: examples: Result: value: "{\n \"code\": 500,\n \"message\": \"Internal error\",\n \"type\": \"safetyApi.internalError\"\ ,\n}" deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://api.getmati.com/safety/v1/upload/watchlists/file' \\\n --header\ \ 'Content-Type: multipart/form-data' \\\n --header 'Authorization: Bearer {{access_token}}' \\\n --form 'watchlistId=\"\ 10\"' \\\n --form 'csvSeparator=\";\"' \\\n --form 'callbackUrl=\"https://callback.url/\"' \\\n --form 'file=@\"\ /Users/user/files/watchlist_file.csv\"'" samples-languages: - curl tags: - Custom Watchlists