> ## Documentation Index
> Fetch the complete documentation index at: https://legitimuz.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get SDK

> KYC (API): GET SDK URL



## OpenAPI

````yaml POST /kyc/get-sdk-url
openapi: 3.0.3
info:
  title: Legitimuz Parceiros (API Partners)
  description: >-
    The Legitimuz Partners API is developed in the REST style (opens new
    window). To connect to our API, we provide authentication through three main
    parameters: Username and Password. These will be provided via registration,
    which can be done through the SignUp endpoint.

    The API is accessed through standard RESTful HTTP requests. For more
    information, we are available to assist you.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.legitimuz.com
security: []
tags:
  - name: Auth
    description: >-
      Here we will discuss the authentication and registration of new Users; we
      have 3 main endpoints: Login, SignUp, and Me.


      **In Login,** you can authenticate by providing Username/Password and
      obtain the Bearer Token for authentication.


      **In SignUp,** you can register your account: company data, name, tax
      identification number (CNPJ), and the first user: name, personal
      identification number (CPF), username, date of birth.


      **In "Me",** you will have all the data related to your created account,
      and important IDs to use in subsequent requests.
  - name: Integrations
    description: >-
      Module that manages the API integration keys, where consultation of all
      created and active keys is available.

      **In List**, all queries of active keys are available.

      **In Create**, the creation of new integration keys that will be used in
      the following Endpoints is available.

      **Attention: Manage your API keys carefully, as they provide access to all
      Legitimuz product queries, and should be stored carefully to be used only
      in your product.**
  - name: SMS
    description: >-
      Here we will discuss the authentication and registration of new Users; we
      have 3 main endpoints: Login, SignUp, and Me.
  - name: AML
    description: >-
      Here we will discuss the authentication and registration of new Users; we
      have 3 main endpoints: Login, SignUp, and Me.
  - name: KYC
    description: >-
      In this module, the process of validation and knowledge of your clients
      (KYC, Know Your Client) is carried out.

      There are 4 main endpoints provided for client consultations and
      validations:


      - **OCR Document**
          The validation of the document sent along with the client's CPF (Personal Tax ID in Brazil) is conducted, where various databases and credit bureaus are consulted to verify if the client's provided data actually matches the document. If any inconsistency is found, a "**Manual Review**" alert is returned. If more than one inconsistency is detected, a "_Failed Analysis_" alert is displayed.

      - **Facematch**
          The validation of the client's face or facial features is conducted in comparison with the photo on the submitted document. It is necessary to submit a document with a clear, high-resolution photo so that the comparison can be accurately performed. After the validation, a percentage match between the two images is generated, where only a similarity of 80% or higher between the two faces is considered valid.

      - **CPF Enrichment**
          Endpoint designed for Enrichment / Consultation of client information through the CPF, returning various data such as Full Name, Mother's Name, Address, Phone Number, Email, Age, Date of Birth, etc.

      - **CEP (zip code) Enrichment**
          Returns address data from a call made using the zip code (CEP), returning the Street, State, City, and Neighborhood.
  - name: Receita Federal
paths:
  /kyc/get-sdk-url:
    post:
      tags:
        - KYC
      summary: 'KYC (API): GET SDK URL'
      description: 'KYC (API): GET SDK URL'
      operationId: kycApiGetSdkUrl
      parameters:
        - name: Origin
          in: header
          schema:
            type: string
            example: dashboard.legitimuz.com
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                cpf:
                  description: CPF of the Client to be validated.
                  type: string
                  example: ''
                token:
                  description: Legitimuz Token (Created in Integrations -> Create).
                  type: string
                  example: ''
      responses:
        '200':
          description: 'KYC (API): GET SDK URL'
          headers:
            Connection:
              schema:
                type: string
                example: keep-alive
            Date:
              schema:
                type: string
                example: Wed, 17 Apr 2024 19:31:12 GMT
            Keep-Alive:
              schema:
                type: string
                example: timeout=5
            access-control-allow-credentials:
              schema:
                type: string
                example: 'true'
            access-control-allow-origin:
              schema:
                type: string
                example: dashboard.legitimuz.com
            content-length:
              schema:
                type: string
                example: '968'
          content:
            application/json:
              schema:
                type: object
                properties:
                  personId:
                    type: number
                    example: 1040
                  url:
                    type: string
                    example: >-
                      https://widget.legitimuz.com/ocr/bd8854e7-1c34-4f7f-997e-b2a859cbad0b?token=78c93b05-e894-4ca5-9367-80cabedb4ec5&lang=pt
                  vp:
                    type: object
                    properties:
                      cpf:
                        type: string
                        example: '06617706137'
                      created_at:
                        type: string
                        example: '2024-04-17T16:31:11.724-03:00'
                      id:
                        type: number
                        example: 1040
                      id_integration:
                        type: number
                        example: 5
                      meta:
                        type: object
                        properties:
                          cliente:
                            type: object
                            properties:
                              cpf:
                                type: string
                                example: '06617706137'
                              data_emissao:
                                type: string
                                example: ''
                              data_inscricao:
                                type: string
                                example: ''
                              data_inscricao_antes_1990:
                                type: boolean
                                example: false
                              data_nascimento:
                                type: string
                                example: '2005-09-07'
                              digito_verificador:
                                type: string
                                example: '37'
                              genero:
                                type: string
                                example: ''
                              idade:
                                type: string
                                example: '18'
                              nacionalidade:
                                type: string
                                example: ''
                              nome:
                                type: string
                                example: Lucas Toledo Sartori
                              nome_mae:
                                type: string
                                example: Gemima Toledo Sartori
                              outros_campos:
                                type: object
                                properties:
                                  exclusive_name:
                                    type: string
                                    example: ''
                                  nome:
                                    type: object
                                    properties:
                                      nomeDoMeio:
                                        type: string
                                        example: Toledo
                                      nomeSocial:
                                        type: string
                                        example: Lucas Sartori
                                      primeiroNome:
                                        type: string
                                        example: Lucas
                                      sobrenome:
                                        type: string
                                        example: Sartori
                                  obito:
                                    type: boolean
                                    example: false
                                  origem:
                                    type: string
                                    example: Receita Federal
                                  pep:
                                    type: boolean
                                    example: false
                                  situacao:
                                    type: string
                                    example: Regular
                                  uf_cpf:
                                    type: string
                                    example: ''
                              signo:
                                type: string
                                example: ''
                          status:
                            type: string
                            example: Iniciado
                      name:
                        type: string
                        example: Lucas Toledo Sartori
                      session_id:
                        type: string
                        example: bd8854e7-1c34-4f7f-997e-b2a859cbad0b
                      status:
                        type: string
                        example: Iniciado
                      tenant_id:
                        type: number
                        example: 13
                      updated_at:
                        type: string
                        example: '2024-04-17T16:31:11.724-03:00'
                      validation_step:
                        type: number
                        example: 1
              examples:
                'KYC (API): GET SDK URL':
                  value:
                    personId: 1040
                    url: >-
                      https://widget.legitimuz.com/ocr/bd8854e7-1c34-4f7f-997e-b2a859cbad0b?token=78c93b05-e894-4ca5-9367-80cabedb4ec5&lang=pt
                    vp:
                      cpf: '06617706137'
                      created_at: '2024-04-17T16:31:11.724-03:00'
                      id: 1040
                      id_integration: 5
                      meta:
                        cliente:
                          cpf: '06617706137'
                          data_emissao: ''
                          data_inscricao: ''
                          data_inscricao_antes_1990: false
                          data_nascimento: '2005-09-07'
                          digito_verificador: '37'
                          genero: ''
                          idade: '18'
                          nacionalidade: ''
                          nome: Lucas Toledo Sartori
                          nome_mae: Gemima Toledo Sartori
                          outros_campos:
                            exclusive_name: ''
                            nome:
                              nomeDoMeio: Toledo
                              nomeSocial: Lucas Sartori
                              primeiroNome: Lucas
                              sobrenome: Sartori
                            obito: false
                            origem: Receita Federal
                            pep: false
                            situacao: Regular
                            uf_cpf: ''
                          signo: ''
                        status: Iniciado
                      name: Lucas Toledo Sartori
                      session_id: bd8854e7-1c34-4f7f-997e-b2a859cbad0b
                      status: Iniciado
                      tenant_id: 13
                      updated_at: '2024-04-17T16:31:11.724-03:00'
                      validation_step: 1

````