openapi: 3.0.1
info:
  title: Employment Verification API (v1) (v3)
  description: "<div align=\"left\">\n  <img src='https://developer.circulodecredito.com.mx/sites/default/files/2024-01/Logo-Swaggers.png' height='60' width='240'/>\n</div>\n\n# \n\n\n\n**`Fast, Reliable Employment Verification for Mexico's Private sector`**\n\n### **Overview** \nThis API provides a comprehensive solution for verifying employment status and retrieving relevant data, including predictive models that assess creditworthiness and job stability.\n\n\n\n ### **Main Features**\n\n🏆 **Predictive Models data**\n* ✅ **Credit Score:** This API now includes a credit score value in the response, providing insights into the applicant's creditworthiness, ranging from 100 to 600.\n* ✅ **Stability Index:** Get a quick assessment of an individual's job stability based on their employment history and industry trends, which can be combined with the Credit Score for a comprehensive evaluation.\n\n🏆 **Accelerated Validity Verification (Time Booster):** This feature enables immediate validation of data validity when the 'minimumRecencyDays' parameter is included in the request. It verifies if the retrieved information remains valid for at least the specified number of days. If the validity period is shorter, the request will processed as usual.\n\n**Make informed lending decisions with Employment Verification API:**\n\n* ✅ **Instant Verification:** Confirm employment status in seconds.\n* ✅ **Risk Mitigation:** Identify potential risks associated with applicants.\n* ✅ **Data-Driven Insights:** Gain access to optional detailed employment data.\n* ✅ **Easy Integration:** Seamlessly integrate with your existing systems. \n\n\n\n**Important!**\n\n * Please note that this API operates asynchronously. Once a request is made, the verification process will continue in the background, and you will receive a notification upon completion on your registered webhook. \n* The verifications of this API version only verify against the IMSS (Instituto Mexicano del Seguro Social).\n* The features EV Credit Score & Timebooster are only supported on v3 version. \n* In order to use EVA, must create a subscription pointing to the next events: **mx.com.circulodecredito.eva** for V1 and **mx.com.circulodecredito.eva.models** for V3 \n\n**\U0001F680 Get started with EVA and make smarter lending decisions today!**\n\n<div align=\"center\"><img src='https://developer.circulodecredito.com.mx/sites/default/files/2024-12/EVA%20CDC%20CL%20-%20Time%20Booster%20%20-%20APIhub%20overview.jpeg' width='85%'/></div>" 

  contact:
    email: api@circulodecredito.com.mx
  version: 3.0.0
servers:
  - url: 'https://services.circulodecredito.com.mx'
tags:
  - name: Simple Employment Verification (v1) 
    externalDocs:
      description: API Hub
      url: 'https://developer.circulodecredito.com.mx'
  - name: Employment Verification With Predictive Models (v3) 
    externalDocs:
      description: API Hub
      url: 'https://developer.circulodecredito.com.mx'
security:
  - api-key: []
paths:
  /v1/eva/employmentverifications/withPrivacyNotice:
    post:
      tags:
        - Simple Employment Verification (v1) 
      summary: Comprehensive Employment Verification Request with enriched mode suppport (internal database)
      description: |
        **`Verify a person's employment status and retrieve relevant data with flexible options.`**

        **Choose Your Data Retrieval Mode:**

        * **`ENRICHED` (Default if not processingModel is provided):** 

            * Prioritizes retrieving historical data from internal sources if online extraction can't complete on waitingTimeout interval, default wait time is 30 minutes if not provided. Specify this mode explicitly by setting **processingModel: "ENRICHED"**
            
            * Allows you to set a custom **waitingTimeout** property (in minutes) to define how long to wait for the external source before resorting to historical data. Choose from (minutes):
              * 5
              * 10
              * 15
              * 30 (default)
              * 60
              * 120
              * 180
                
            * **Understanding Responses:**
            When using **ENRICHED** mode (default or with custom timeout), the response will include:

              * **extractionType:** Indicates the source of the data ("internal" or "external").
              
              * **dataExtractionDate:** Provides the precise date and time the data was retrieved.
        * **`GATEWAY (Online)`:** Retrieves the latest real-time data from an external open data source. Specify this mode explicitly by setting **processingModel: "GATEWAY"**.


        **Additional Verification Features (Compatible for Combining):**


        * **`Stability Index: `** Get a quick assessment of an individual's job stability based on their employment history and industry trends, which can be combined with the Credit Score for a comprehensive evaluation.

        * **`Enhanced Analytics(v1):`** Gain deeper insights with historical job movement data and detailed analysis, allowing for integration with both the Credit Score and Stability Index for a holistic view of an applicant's profile. 

      operationId: employmentverificationsSimple
      parameters:
        - name: x-api-key
          in: header
          description: The Consumer Key assigned to the application you have registered in API Hub.
          required: true
          schema:
            type: string
        - name: username
          in: header
          description: Username of the inquiry user.
          required: true
          schema:
            type: string
        - name: password
          in: header
          description: Password of the inquiry user.
          required: true
          schema:
            type: string
        - name: x-signature
          in: header
          description: The signature (X-Signature) is generated using your private key (SHA256withECDSA - secp384r) by signing the entire POST request. The X-Signature is included in the request header, and the API Hub verifies that the signature matches the request using your public key, which must be registered in the applications section of the API Hub portal.
          required: true
          schema:
            type: string

      requestBody:
        description: Input parameters in order to start a employment verification process.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmploymentVerificationv1Body'
            examples:
              simple-evrequest:
                summary: 'Basic Employment Verification'
                description: |
                  This endpoint allows you to perform a basic employment verification request. The response will provide raw data from the IMSS (Instituto Mexicano del Seguro Social) or from the internal database if the specified waitingTimeout is reached.

                  **How It Works:**

                  When a request is made, the system will attempt to retrieve the latest employment data from the IMSS. If the online extraction cannot complete within the defined 'waitingTimeout', the system will fallback to using historical data from the internal database.

                  **Response Behavior:**

                  - If the data is successfully retrieved from the IMSS within the timeout, the response will include the most current employment information.
                  - If the timeout is reached, the response will include historical data from the internal database, ensuring that you still receive relevant information.

                  **Why This Matters:**

                  This approach ensures that you have access to timely employment verification data while also providing a fallback option to maintain data availability and reliability.
              
                value:
                  privacyNotice:
                    fullName:
                      firstName: ROBERTO
                      middleName: string
                      firstSurname: SAHAGUN
                      secondSurname: ZARAGOZA
                      aditionalSurname: string
                    address:
                      streetAndNumber: HIDALGO 32
                      settlement: CENTRO
                      county: LA BARCA
                      city: BENITO JUAREZ
                      state: JAL
                      postalCode: '47917'
                    acceptanceDate: '2020-04-12T22:20:50.52Z'
                    acceptance: 'Y'
                  employmentVerification:
                    employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                    subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                    curp: BADD110313HCMLNS09
                    email: api@circulodecredito.com.mx
                    
              simple-enrich-stability-vars:
                summary: 'Employment Verification with Employment Stability Index & Enhanced Analytics (v1) (using ENRICH)'
                description: |
                  **Employment Stability Index and Enhanced Analytics:**
                  - The Employment Stability Index provides insights into an individual's job stability based on their employment history and industry trends, which can be combined with the EV Credit Score for a comprehensive evaluation.
                  - Enhanced Analytics offers deeper insights into an individual's career trajectory, including detailed historical job movement data, key statistics, and trends that inform lending decisions.
                value:
                  privacyNotice:
                    fullName:
                      firstName: ROBERTO
                      middleName: string
                      firstSurname: SAHAGUN
                      secondSurname: ZARAGOZA
                      aditionalSurname: string
                    address:
                      streetAndNumber: HIDALGO 32
                      settlement: CENTRO
                      county: LA BARCA
                      city: BENITO JUAREZ
                      state: JAL
                      postalCode: '47917'
                    acceptanceDate: '2020-04-12T22:20:50.52Z'
                    acceptance: 'Y'
                  employmentVerification:
                    employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                    subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                    curp: BADD110313HCMLNS09
                    email: api@circulodecredito.com.mx
                    employmentStabilityIndex: true
                    enhancedAnalytics: true
                    processingModel: ENRICHED
                    waitingTimeout: 30
                    
              stabilityindex-only-gateway:
                summary: 'Employment Verification with Enhanced Analytics (using GATEWAY)'
                description: |
                  Gain deeper insights into an individual's career trajectory with enriched analytics.

                  **Enable Enhanced Analytics:**

                  Include **"enhancedAnalytics": true** in your request to receive detailed historical job movement data, including:

                  * **Type 1 Analysis:**
                    * Key Statistics: Days of employment, lifetime earnings, maximum base salary, and net income.
                    * Historical Trends: Detailed breakdown of net income and base salary changes over time, including employment status.
                  * **Type 2 Analysis:**
                    * Employment Summary: Number of distinct employers, percentage of weeks with social security contributions and deductions, and total weeks of employment.

                  **Benefits:**

                  * **Deeper Understanding:**  Uncover patterns in an individual's career progression.
                  * **Informed Decisions:**  Assess financial stability and potential risks.
                  * **Enhanced Profiling:**  Create a more comprehensive profile for better decision-making.
                value:
                  privacyNotice:
                    fullName:
                      firstName: ROBERTO
                      middleName: string
                      firstSurname: SAHAGUN
                      secondSurname: ZARAGOZA
                      aditionalSurname: string
                    address:
                      streetAndNumber: HIDALGO 32
                      settlement: CENTRO
                      county: LA BARCA
                      city: BENITO JUAREZ
                      state: JAL
                      postalCode: '47917'
                    acceptanceDate: '2020-04-12T22:20:50.52Z'
                    acceptance: 'Y'
                  employmentVerification:
                    employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                    subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                    curp: BADD110313HCMLNS09
                    email: api@circulodecredito.com.mx
                    processingModel: GATEWAY
                    enhancedAnalytics: true

        required: true
      responses:
        '200':
          description: OK - Returns an employment verification request acknowledge.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckSuccessEVConsumptionIMSS'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '400'
                    message: 'Missign parameters {employmentVerificationRequestId, subscriptionId, curp, email}'
                  - code: '400.0'
                    message: '[Path /employmentVerification/suscriptionId] Input string {{suscriptionId}} is not a valid UUID: []'
                  - code: '400.1'
                    message: 'EmploymentVerificationRequestId already exists'
                  - code: '400.1'
                    message: 'The CURP does not have the correct format.'
                  - code: '400.1'
                    message: 'ERROR - [Path /employmentVerification/processingModel] the provided value does not match the catalog.'
                  - code: '400.1'
                    message: 'A required parameter was not added.'
                  - code: '400.2'
                    message: 'The email does not meet the required format.'
                  - code: '400.2'
                    message: 'ERROR - [Path /employmentVerification/suscriptionId] does not match input string {{suscriptionId}}'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '401.1'
                    message: 'Unauthorized, invalid x-api-key.'
                  - code: '401.1'
                    message: 'Not found subscriptionId {}'
                  - code: '401.2'
                    message: 'Unauthorized, invalid credentials.'
                  - code: '401.3'
                    message: 'Unauthorized, you do not have the product.'
                  - code: '401.4'
                    message: 'Unauthorized, you do not have access to the resource.'
        
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '403.1'
                    message: 'We could not verify the signature, x-signature is invalid'
                    
        '404':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '404'
                    message: 'The server understood the request but refuses to authorize it.'
                  - code: '404.1'
                    message: 'Not found SuscriptionId: {{suscriptionId}}.'
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '429'
                    message: Too many requests.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '500'
                    message: 'There was an unexpected error, try again later.'
        '503':
          description: Service unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '503'
                    message: Service unavailable.
      x-codegen-request-body-name: request
  /v3/eva/employmentverifications/withPrivacyNotice:
    post:
      tags:
        - Employment Verification With Predictive Models (v3) 
      summary: Comprehensive Employment Verification Request with Predictive and analytic Insights
      description: |
        **`Verify a person's employment status and retrieve relevant data with flexible options, including a credit score retrieval.`**

        **Choose Your Data Retrieval Mode:**

        * **`ENRICHED` (Default if not processingModel is provided):** 

            * Prioritizes retrieving historical data from internal sources if online extraction can't complete on waitingTimeout interval, default wait time is 30 minutes if not provided. Specify this mode explicitly by setting **processingModel: "ENRICHED"**
            
            * Allows you to set a custom **waitingTimeout** property (in minutes) to define how long to wait for the external source before resorting to historical data. Choose from (minutes):
              * 5
              * 10
              * 15
              * 30 (default)
              * 60
              * 120
              * 180
                
            * **Understanding Responses:**
            When using **ENRICHED** mode (default or with custom timeout), the response will include:

              * **extractionType:** Indicates the source of the data ("internal" or "external").
              
              * **dataExtractionDate:** Provides the precise date and time the data was retrieved.
        * **`GATEWAY (Online)`:** Retrieves the latest real-time data from an external open data source. Specify this mode explicitly by setting **processingModel: "GATEWAY"**.


        **Additional Verification Features (Compatible for Combining):**

        * **`Accelerated Validity Verification (Time Booster): `** This feature enables immediate validation of data validity when the 'minimumRecencyDays' parameter is included in the request. It verifies if the retrieved information remains valid for at least the specified number of days. If the validity period is shorter, the request will processed as usual.(this feature only works with the ENRICHED processing model selected)

        * **`Credit Score: `** Based on labor history and credit information from Circulo de Credito, this score is inferred by predictive models to provide a decision-making indicator. Gain deeper insights with historical job movement data and detailed analysis. 

        * **`Stability Index: `** Get a quick assessment of an individual's job stability based on their employment history and industry trends, which can be combined with the Credit Score for a comprehensive evaluation.

        * **`Enhanced Analytics:`** Gain deeper insights with historical job movement data and detailed analysis, allowing for integration with both the Credit Score and Stability Index for a holistic view of an applicant's profile. 
        
        * **`Extended Analytics:`** Deliver key insights derived from a person's work history. By analyzing various aspects such as total working lifetime, job stability, details of the last job, unemployment trends, work continuity, and salary movements, it efficiently identifies valuable indicators that reveal meaningful patterns in the individual's career trajectory.
        
      operationId: employmentverificationsWithPredictiveModels
      parameters:
        - name: x-api-key
          in: header
          description: The Consumer Key assigned to the application you have registered in API Hub.
          required: true
          schema:
            type: string
        - name: username
          in: header
          description: Username of the inquiry user.
          required: true
          schema:
            type: string
        - name: password
          in: header
          description: Password of the inquiry user.
          required: true
          schema:
            type: string
        - name: x-signature
          in: header
          description: The signature (X-Signature) is generated using your private key (SHA256withECDSA - secp384r) by signing the entire POST request. The X-Signature is included in the request header, and the API Hub verifies that the signature matches the request using your public key, which must be registered in the applications section of the API Hub portal.
          required: true
          schema:
            type: string

      requestBody:
        description: Input parameters in order to start a employment verification process with predictive models(EV Credit Score, Employment Stability Index & Time Booster), 
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmploymentVerificationWithPredictiveModelsV3Body'
            examples:
              credit-score-timebooster:
                summary: 'Employment Verification with Predictive Models (using Time Booster)'
                description: |
                  TimeBooster is a feature designed to significantly speed up data retrieval and processing, especially when validating data based on a minimum Recency period. It optimizes performance for key operations, improving overall system efficiency and ensuring data freshness.
              
                  **`What is TimeBooster?`**
              
                  TimeBooster enhances performance by:
              
                  *   Reducing processing time for data requests.
                  *   Improving the speed of data delivery.
                  *   Efficiently validating data against the `minimumRecencyDays` value.
              
                  **`How It Works:`**
              
                  TimeBooster uses techniques such as:
              
                  *   Caching frequently accessed data.
                  *   Optimizing data handling processes.
                  *   Pre-filtering data based on the `minimumRecencyDays` value.
              
                  **`Why This Matters:`**
              
                  TimeBooster helps to:
              
                  *   Provide a better user experience with quicker responses.
                  *   Improve system efficiency and handle more requests.
                  *   Ensure that only valid, up-to-date data (respecting `minimumRecencyDays`) is returned.
              
                  **`When is TimeBooster Used?`**
              
                  TimeBooster is applied to:
              
                  *   Commonly requested data.
                  *   Performance-critical parts of the system.
                  *   Requests that include the `minimumRecencyDays` parameter.
                value:
                  privacyNotice:
                    fullName:
                      firstName: ROBERTO
                      middleName: string
                      firstSurname: SAHAGUN
                      secondSurname: ZARAGOZA
                      aditionalSurname: string
                    address:
                      streetAndNumber: HIDALGO 32
                      settlement: CENTRO
                      county: LA BARCA
                      city: BENITO JUAREZ
                      state: JAL
                      postalCode: '47917'
                    acceptanceDate: '2020-04-12T22:20:50.52Z'
                    acceptance: 'Y'
                  employmentVerification:
                    employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                    subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                    curp: BADD110313HCMLNS09
                    email: api@circulodecredito.com.mx
                    predictiveModels: true
                    enhancedAnalytics: true
                    minimumRecencyDays: 60
                    
              credit-score-gateway:
                summary: 'Employment Verification with Predictive Models (using GATEWAY)'
                description: |
                  The EV Credit Score is a numerical snapshot of an individual's labor history at a specific point in time, linking their score to the risk of defaulting on credit obligations. It serves as a predictive indicator of creditworthiness, helping to assess the likelihood of timely repayments on loans and credit obligations.

                  **`What is the EV Credit Score?`**

                  The EV Credit Score is derived from the individual's credit profile available through Círculo de Crédito, producing a numerical score that indicates the future credit risk associated with granting credit to the applicant.

                  **Factors Considered in Calculating the EV Credit Score:**

                  The EV Credit Score takes into account:
                  - Report of weeks contributed to IMSS.

                  **Range of EV Credit Score:**
                  - The EV Credit Score ranges from 100 to 600 points.

                  **Risk Levels:**
                  - The EV Credit Score does not represent different risk levels but orders the risk of default (30 days late in the next 3 months) based solely on information provided by IMSS.

                  **For more details, please contact the sales team directly.**
                value:
                  privacyNotice:
                    fullName:
                      firstName: ROBERTO
                      middleName: string
                      firstSurname: SAHAGUN
                      secondSurname: ZARAGOZA
                      aditionalSurname: string
                    address:
                      streetAndNumber: HIDALGO 32
                      settlement: CENTRO
                      county: LA BARCA
                      city: BENITO JUAREZ
                      state: JAL
                      postalCode: '47917'
                    acceptanceDate: '2020-04-12T22:20:50.52Z'
                    acceptance: 'Y'
                  employmentVerification:
                    employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                    subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                    curp: BADD110313HCMLNS09
                    email: api@circulodecredito.com.mx
                    processingModel: GATEWAY
                    enhancedAnalytics: true
                    predictiveModels: true
                    
              enhancedAnalytics-enrich:
                summary: 'Employment Verification with  Enhanced Analytics (using ENRICHED)'
                description: |
                  Gain deeper insights into an individual's career trajectory with enriched analytics.

                  **`Enable Enhanced Analytics:`**

                  Include **"enhancedAnalytics": true** in your request to receive detailed historical job movement data, including:

                  * **Type 1 Analysis:**
                    * Key Statistics: Days of employment, lifetime earnings, maximum base salary, and net income.
                    * Historical Trends: Detailed breakdown of net income and base salary changes over time, including employment status.
                  * **Type 2 Analysis:**
                    * Employment Summary: Number of distinct employers, percentage of weeks with social security contributions and deductions, and total weeks of employment.

                  **Benefits:**

                  * **Deeper Understanding:**  Uncover patterns in an individual's career progression.
                  * **Informed Decisions:**  Assess financial stability and potential risks.
                  * **Enhanced Profiling:**  Create a more comprehensive profile for better decision-making.
                value:
                  privacyNotice:
                    fullName:
                      firstName: ROBERTO
                      middleName: string
                      firstSurname: SAHAGUN
                      secondSurname: ZARAGOZA
                      aditionalSurname: string
                    address:
                      streetAndNumber: HIDALGO 32
                      settlement: CENTRO
                      county: LA BARCA
                      city: BENITO JUAREZ
                      state: JAL
                      postalCode: '47917'
                    acceptanceDate: '2020-04-12T22:20:50.52Z'
                    acceptance: 'Y'
                  employmentVerification:
                    employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                    subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                    curp: BADD110313HCMLNS09
                    email: api@circulodecredito.com.mx
                    processingModel: ENRICHED
                    enhancedAnalytics: true
                    predictiveModels: true
                    
              enhancedAnalytics-enrich-v2:
                summary: 'Employment Verification with  Enhanced Analytics, Predictive Models & Extended Analytics (using ENRICHED)'
                description: |
                  Gain deeper insights into an individual's career trajectory with enriched analytics.

                  **`Enable Enhanced Analytics:`**

                  Include **"enhancedAnalytics": true** in your request to receive detailed historical job movement data, including:

                  * **Type 1 Analysis:**
                    * Key Statistics: Days of employment, lifetime earnings, maximum base salary, and net income.
                    * Historical Trends: Detailed breakdown of net income and base salary changes over time, including employment status.
                  * **Type 2 Analysis:**
                    * Employment Summary: Number of distinct employers, percentage of weeks with social security contributions and deductions, and total weeks of employment.
                    
                  **`Enable Extended Analytics:`**

                  Include **"extendedAnalytics": true** in your request to analyze various aspects such as total working lifetime, job stability, details of the last job, unemployment trends, work continuity, and salary movements.

                  * **Job Stability:**
                    * Key Statistics: Person average new jobs per year count, person average unique employers per year count,person maximum new jobs per year count, person maximum unique employers per year count, person total new jobs count, person total unique employeers count, person working lifetime ratio percentage, work histor average duration months, work history maximum duration months,work history minimum duration months, work history total duration months.
                  * **Last Job:**
                    * Key Statistics: last job average ratio percentage, last job duration days, last job duration months, last job end date date, last job maximum ratio percentage, last job start age decile, last job start age years, last job start date date, last job total ratio percentage, last job work history ratio percentage.
                  * **Person:**
                    * Key Statistics: person age decile, person age years, person working status flag
                  * **Unemployment:**
                    * Key Statistics: last unemployment average ratio percentage, last unemployment duration days, last unemployment duration months, last unemployment maximum ratio percentage, last unemployment start date, last unemployment total ratio percentage, last unemployment work history ratio percentage, person average unemployment period months, person maximum unemployment period months, person minimum unemployment period months, person total unemployment decile, person total unemployment months
                  * **Wage:**
                    * Key Statistics: last job daily wage amount, last job monthly wage amount, person average daily net income amount, person last 3 years daily average net income amount, person last 3 years daily maximum net income amount, person last 3 years minimum net income amount, person last 3 years total net income amount, person last 5 years daily average net income amount, person last 5 years daily maximum net income amount, person last 5 years minimum net income amount, person last 5 years total net income amount, person last year daily average net income amount, person last year daily maximum net income amount, person last year minimum net income amount, person last year total net income amount, person maximum daily net income amount, person minimum daily net income amount, person total net income amount, wage change first last percentage, work history average wage increment percentage, work history maximum wage increment percentage, work history minimum wage increment percentage.
                  * **Working Continuity:**
                    * Key Statistics: last continuous contribution period average ratio percentage, last continuous contribution period duration days, last continuous contribution period duration decil, last continuous contribution period duration months, last continuous contribution period duration weeks, last continuous contribution period duration years, last continuous contribution period history ratio percentage, last continuous contribution period maximum ratio percentage, last continuous contribution period start date date, last continuous contribution period total ratio percentage.
                  * **Working Lifetime:**
                    * Key Statistics: person adult working lifetime years, person average months with multiple jobs count, person maximum months with multiple jobs count, person maximum multiple jobs count, person total months with multiple jobs count, person working age years, person working lifetime days, person working lifetime decile, person working lifetime months, person working lifetime weeks, person working start age quartile, person working start age years, person working start date date, working history avg days, working history max days, working history min days, working history total days.
 
                  **Benefits:**

                  * **Deeper Understanding:**  Uncover patterns in an individual's career progression.
                  * **Informed Decisions:**  Assess financial stability and potential risks.
                  * **Enhanced Profiling:**  Create a more comprehensive profile for better decision-making.
                value:
                  privacyNotice:
                    fullName:
                      firstName: ROBERTO
                      middleName: string
                      firstSurname: SAHAGUN
                      secondSurname: ZARAGOZA
                      aditionalSurname: string
                    address:
                      streetAndNumber: HIDALGO 32
                      settlement: CENTRO
                      county: LA BARCA
                      city: BENITO JUAREZ
                      state: JAL
                      postalCode: '47917'
                    acceptanceDate: '2020-04-12T22:20:50.52Z'
                    acceptance: 'Y'
                  employmentVerification:
                    employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                    subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                    curp: BADD110313HCMLNS09
                    email: api@circulodecredito.com.mx
                    processingModel: ENRICHED
                    enhancedAnalytics: true
                    extendedAnalytics: true
                    predictiveModels: true
              
              credit-score-timebooster-v2:
                summary:  'Employment Verification with  Enhanced Analytics, Predictive Models & Extended Analytics (using Time Booster)'
                description: |
                  TimeBooster is a feature designed to significantly speed up data retrieval and processing, especially when validating data based on a minimum Recency period. It optimizes performance for key operations, improving overall system efficiency and ensuring data freshness.
              
                  **`What is TimeBooster?`**
              
                  TimeBooster enhances performance by:
              
                  *   Reducing processing time for data requests.
                  *   Improving the speed of data delivery.
                  *   Efficiently validating data against the `minimumRecencyDays` value.
              
                  **`How It Works:`**
              
                  TimeBooster uses techniques such as:
              
                  *   Caching frequently accessed data.
                  *   Optimizing data handling processes.
                  *   Pre-filtering data based on the `minimumRecencyDays` value.
              
                  **`Why This Matters:`**
              
                  TimeBooster helps to:
              
                  *   Provide a better user experience with quicker responses.
                  *   Improve system efficiency and handle more requests.
                  *   Ensure that only valid, up-to-date data (respecting `minimumRecencyDays`) is returned.
              
                  **`When is TimeBooster Used?`**
              
                  TimeBooster is applied to:
              
                  *   Commonly requested data.
                  *   Performance-critical parts of the system.
                  *   Requests that include the `minimumRecencyDays` parameter.
                value:
                  privacyNotice:
                    fullName:
                      firstName: ROBERTO
                      middleName: string
                      firstSurname: SAHAGUN
                      secondSurname: ZARAGOZA
                      aditionalSurname: string
                    address:
                      streetAndNumber: HIDALGO 32
                      settlement: CENTRO
                      county: LA BARCA
                      city: BENITO JUAREZ
                      state: JAL
                      postalCode: '47917'
                    acceptanceDate: '2020-04-12T22:20:50.52Z'
                    acceptance: 'Y'
                  employmentVerification:
                    employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                    subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                    curp: BADD110313HCMLNS09
                    email: api@circulodecredito.com.mx
                    predictiveModels: true
                    enhancedAnalytics: true
                    extendedAnalytics: true
                    minimumRecencyDays: 60

                
        required: true
      responses:
        '200':
          description: OK - Returns an employment verification request acknowledge.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckSuccessEVConsumptionIMSS'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '400'
                    message: 'Missign parameters {employmentVerificationRequestId, subscriptionId, curp, email}'
                  - code: '400.1'
                    message: 'ERROR - [Path /employmentVerification/processingModel] the provided value does not match the catalog.'
                  - code: '400.1'
                    message: 'EmploymentVerificationRequestId already exists'
                  - code: '400.1'
                    message: 'ERROR - [Path /employmentVerification/suscriptionId] the provided value does not match the catalog.'  
                  - code: '400.2'
                    message: 'The CURP does not have the correct format.'
                  - code: '400.2'
                    message: 'The email does not meet the required format.'
                  - code: '400.2'
                    message: 'ERROR - [Path /employmentVerification/suscriptionId] does not match input string {{suscriptionId}}'
                  - code: '400.3'
                    message: 'A required parameter was not added.'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '401.1'
                    message: 'Unauthorized, invalid x-api-key.'
                  - code: '401.1'
                    message: 'Not found subscriptionId {}'
                  - code: '401.2'
                    message: 'Unauthorized, invalid credentials.'
                  - code: '401.3'
                    message: 'Unauthorized, you do not have the product.'
                  - code: '401.4'
                    message: 'Unauthorized, you do not have access to the resource.'
                    
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '403.1'
                    message: 'We could not verify the signature, x-signature is invalid'
                    
        '404':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '404'
                    message: 'The server understood the request but refuses to authorize it.'
                  - code: '404.1'
                    message: 'Not found SuscriptionId: {{suscriptionId}}.'
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '429'
                    message: Too many requests.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '500'
                    message: 'There was an unexpected error, try again later.'
        '503':
          description: Service unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '503'
                    message: Service unavailable.
      x-codegen-request-body-name: request
  /v1/eva/employmentverifications/{inquiryId}:
    get:
      tags:
        - Simple Employment Verification (v1)
      
      summary: Retrieve detailed information about employment verifications with the laboral data.
      description: |
        **`Get the detailed employment verification results for a specific inquiry.`**
        

        Use this endpoint to retrieve the full response associated with a particular employment verification process.

        **Inquiry Identification:**

          * The inquiry is identified by the unique `inquiryId` included in the request path.


        **Understanding Inquiry Status property:**

        The **inquiryStatus** field provides crucial information about the progress and outcome of the verification process:

        | Status Code | Meaning                                                                                                                    |
        |------------|----------------------------------------------------------------------------------------------------------------------------|
        | RI         | Círculo de Crédito has received the inquiry and will begin processing it soon.                                                |
        | SN         | The inquiry has been processed, and a Webhook event notification is being sent.                                            |
        | DN         | The inquiry is complete, and the notification was successfully delivered to the Webhook API.                              |
        | NDN        | The inquiry is complete, but the notification could not be delivered to the Webhook API after multiple attempts.           |
        | CI         | You have successfully retrieved the response payload, regardless of the notification status.                             |
        | EI         | The inquiry and its results have been archived due to being older than 30 days. These inquiries will not be displayed. |

        **Understanding Working History Object:**

        The **workingHistory** object contains detailed information about the employment history of the individual. It includes the following properties:

        | Property                     | Description                                                                                     |
        |------------------------------|-------------------------------------------------------------------------------------------------|
        | date                         | The date when the employment history was recorded.                                            |
        | weeksContributed             | An object that provides information about the total weeks contributed, discounted weeks, and reinstated weeks. |
        | workingHistoryDetail         | An array of objects that contains detailed information about each employer, including the employer's name. |

        The **weeksContributed** object has the following children:

        | Property                     | Description                                                                                     |
        |------------------------------|-------------------------------------------------------------------------------------------------|
        | totalContributedWeeks        | The total number of weeks the individual has contributed to their employment.                  |
        | discountedWeeks              | The number of weeks that have been discounted from the total contributions.                    |
        | reinstatedWeeks              | The number of weeks that have been reinstated after being previously discounted.               |

        **Understanding Working History Detail Object:**

        The **workingHistoryDetail** array contains detailed records for each employer the individual has worked for. Each object in this array includes the following properties:

        | Property                     | Description                                                                                     |
        |------------------------------|-------------------------------------------------------------------------------------------------|
        | employerName                 | The name of the employer for the employment record.                                            |
        | employerRegister             | Number or password assigned by the IMSS, to a employer, when it was registered in the institute (registro del patron)                                           |
        | federalEntity                | Name of location of employer.                                                                    |
        | position                     | The job title or position held by the individual at the employer.                               |
        | startDate                    | The date when the individual started working for the employer.                                  |
        | endDate                      | The date when the individual stopped working for the employer.                                  |
        | lastContributionBaseSalary                       | The salary or wage received by the individual during their employment.                          |
        | workStatusEvents             | Array of events inside of same employer                                     |

      operationId: getEmploymentVerification
      parameters:
        - name: x-api-key
          in: header
          description: The Consumer Key assigned to the application you have registered in API Hub.
          required: true
          schema:
            type: string
        - name: username
          in: header
          description: Username of the inquiry user.
          required: true
          schema:
            type: string
        - name: password
          in: header
          description: Password of the inquiry user.
          required: true
          schema:
            type: string
        - name: inquiryId
          in: path
          description: The identifier of the inquiry.
          required: true
          schema:
            type: string
        - name: x-signature
          in: header
          description: The signature (X-Signature) is generated using your private key (SHA256withECDSA - secp384r) by signing only the UUID (inquiryId) included in the GET request path.  The API Hub verifies the X-Signature against the URL using your public key, which must be registered in the applications section of the API Hub portal.
          required: true
          schema:
            type: string
            
      responses:
        '200':
          description: OK - Returns the employment verification process information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fullSuccessEVConsumptionV1'
              examples:
                Simple-Employment-Response:
                  summary: Employment Verification Simple Response
                  description: An example response of employment verification.
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: EmployerName
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045

                        


                Enhanced-Analytics-gateway:
                  summary: Employment Verification with Employment Stability Index and Enhanced Analytics (using GATEWAY)
                  description: An example response of employment verificacion with only Enhanced Analytics requested
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        processingModel: GATEWAY
                        extractionType: External Data Source
                        enhancedAnalytics: true
                        employmentStabilityIndex: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: Name
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045
                    enhancedAnalytics:
                      type1:
                        diasDeContratacion:
                          cDiasDeContratacion: 9
                          diasDeContratacionMax: 1541
                          diasDeContratacionMean: 524
                          diasDeContratacionMedian: 395
                          diasDeContratacionMin: 6
                          diasDeContratacionStd: 487.95
                        lifetimeEarnings: 5023045.76
                        maxBaseSalary:
                          cMaxBaseSalary: 9
                          maxBaseSalaryMax: 2714.25
                          maxBaseSalaryMean: 627.23
                          maxBaseSalaryMedian: 89.89
                          maxBaseSalaryMin: 66.79
                          maxBaseSalaryStd: 995.64
                        netIncome:
                          cNetIncome: 12
                          netIncomeMax: 2714.25
                          netIncomeMean: 455.44
                          netIncomeMedian: 77.81
                          netIncomeMin: 0
                          netIncomeStd: 910.91
                        netIncomeHistorico:
                          - duration: 485
                            employmentStatus: employed
                            endDate: '2024-07-03'
                            event: 12
                            netIncome: 2714.25
                            startDate: '2023-03-06'
                          - duration: 7
                            employmentStatus: employed
                            endDate: '2006-01-02'
                            event: 1
                            netIncome: 66.79
                            startDate: '2005-12-26'
                        pctIncrementoBaseSalary:
                          cPctIncrementoBaseSalary: 8
                          pctIncrementoBaseSalaryMax: 97.13
                          pctIncrementoBaseSalaryMean: -11.32
                          pctIncrementoBaseSalaryMedian: -8.73
                          pctIncrementoBaseSalaryMin: -96.03
                          pctIncrementoBaseSalaryStd: 51.22
                      type2:
                        diasDeContratacion: 485
                        nbDistinctEmployers: 8
                        pctSemanasCotizadas: 100
                        pctSemanasDescontadas: 0
                        totalSalaryDecreases: 2
                        totalSemanas: 675
                    employmentStabilityIndex: nivel_1
                Enhanced-Analytics-enriched:
                  summary: Employment Verification with Employment Stability Index and Enhanced Analytics (using ENRICHED)
                  description: An example response of employment verificacion with only Enhanced Analytics requested with a waiting timeout of 5 min max. In this case the api does not get response from IMSS within the 5 min and reponse with the internal data of CDC.
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        processingModel: ENRICHED
                        extractionType: Internal Data Source
                        dataExtractionDate: 2024-12-18 16:16:36
                        enhancedAnalytics: true
                        employmentStabilityIndex: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: Name
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045
                    enhancedAnalytics:
                      type1:
                        diasDeContratacion:
                          cDiasDeContratacion: 9
                          diasDeContratacionMax: 1541
                          diasDeContratacionMean: 524
                          diasDeContratacionMedian: 395
                          diasDeContratacionMin: 6
                          diasDeContratacionStd: 487.95
                        lifetimeEarnings: 5023045.76
                        maxBaseSalary:
                          cMaxBaseSalary: 9
                          maxBaseSalaryMax: 2714.25
                          maxBaseSalaryMean: 627.23
                          maxBaseSalaryMedian: 89.89
                          maxBaseSalaryMin: 66.79
                          maxBaseSalaryStd: 995.64
                        netIncome:
                          cNetIncome: 12
                          netIncomeMax: 2714.25
                          netIncomeMean: 455.44
                          netIncomeMedian: 77.81
                          netIncomeMin: 0
                          netIncomeStd: 910.91
                        netIncomeHistorico:
                          - duration: 485
                            employmentStatus: employed
                            endDate: '2024-07-03'
                            event: 12
                            netIncome: 2714.25
                            startDate: '2023-03-06'
                          - duration: 7
                            employmentStatus: employed
                            endDate: '2006-01-02'
                            event: 1
                            netIncome: 66.79
                            startDate: '2005-12-26'
                        pctIncrementoBaseSalary:
                          cPctIncrementoBaseSalary: 8
                          pctIncrementoBaseSalaryMax: 97.13
                          pctIncrementoBaseSalaryMean: -11.32
                          pctIncrementoBaseSalaryMedian: -8.73
                          pctIncrementoBaseSalaryMin: -96.03
                          pctIncrementoBaseSalaryStd: 51.22
                      type2:
                        diasDeContratacion: 485
                        nbDistinctEmployers: 8
                        pctSemanasCotizadas: 100
                        pctSemanasDescontadas: 0
                        totalSalaryDecreases: 2
                        totalSemanas: 675
                    employmentStabilityIndex: nivel_1
                

        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '400.1'
                    message: 'Incident ID: 1817000210222690579-404000433340358779'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '401.2'
                    message: 'Unauthorized, invalid credentials.'
                  - code: '401.3'
                    message: 'Unauthorized, you do not have the product.'
                  - code: '401.4'
                    message: 'Unauthorized, you do not have access to the resource.'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '403.1'
                    message: 'We could not verify the signature, x-signature is invalid'
        '404':
          description: Inquiry not found or and error with the verification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckFailureEVConsumption'
              example:
                acknowledgeId: 45f53c81-04e0-42df-abd8-de217e2edf2a
                dateTime: '2020-09-01T03:36:38Z'
                operation: consume
                message: The request has been consumed.
                employmentVerification:
                  errors:
                  - code: "404"
                    message: The inquiry does not exist.
                  - code: "404.1"
                    message: The data in the IMSS database have inconsistencies.
                  - code: "404.2"
                    message: The email is already associated with another CURP.
                  - code: "404.3"
                    message: The person does not have NSS.
                  - code: "404.4"
                    message: The CURP was not found in the external entity (RENAPO)
                  - code: "404.5"
                    message: The service is not available for this request
                  - code: "404.6"
                    message: Request not found on IMSS and Internal Data Source
        '425':
          description: 'Too early - The employment verification process associated with the {inquiryId} path parameter has not yet been completed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '425.2'
                    message: 'The employment verification process associated with the {inquiryId} path parameter has not yet been completed.'
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '429'
                    message: Too many requests.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckFailureEVConsumption'
              example:
                acknowledgeId: 6a2224ec-1e48-4bbd-ba2c-1971dd783735
                dateTime: '2020-09-01T05:32:41Z'
                operation: consume
                message: The request has been consumed.
                employmentVerification:
                  errors:
                    - code: '500'
                      message: 'There was an unexpected error, try again later.'
                    - code: '500.2'
                      message: 'The request could not be processed.'
                    - code: '500.3'
                      message: 'The request could not be delivered.'
        '503':
          description: Service unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '503'
                    message: Service unavailable.
  /v3/eva/employmentverifications/{inquiryId}:
    get:
      tags:
        - Employment Verification With Predictive Models (v3) 
      
      summary: Retrieve detailed information about employment verifications and processing predictive models.
      description: |
        **`Get the detailed employment verification results for a specific inquiry.`**
        

        Use this endpoint to retrieve the full response associated with a particular employment verification process.

        **Inquiry Identification:**

          * The inquiry is identified by the unique `inquiryId` included in the request path.


        **Understanding Inquiry Status property:**

        The **inquiryStatus** field provides crucial information about the progress and outcome of the verification process:

        | Status Code | Meaning                                                                                                                    |
        |------------|----------------------------------------------------------------------------------------------------------------------------|
        | RI         | Círculo de Crédito has received the inquiry and will begin processing it soon.                                                |
        | SN         | The inquiry has been processed, and a Webhook event notification is being sent.                                            |
        | DN         | The inquiry is complete, and the notification was successfully delivered to the Webhook API.                              |
        | NDN        | The inquiry is complete, but the notification could not be delivered to the Webhook API after multiple attempts.           |
        | CI         | You have successfully retrieved the response payload, regardless of the notification status.                             |
        | EI         | The inquiry and its results have been archived due to being older than 30 days. These inquiries will not be displayed. |

        **Understanding Working History Object:**

        The **workingHistory** object contains detailed information about the employment history of the individual. It includes the following properties:

        | Property                     | Description                                                                                     |
        |------------------------------|-------------------------------------------------------------------------------------------------|
        | date                         | The date when the employment history was recorded.                                            |
        | weeksContributed             | An object that provides information about the total weeks contributed, discounted weeks, and reinstated weeks. |
        | workingHistoryDetail         | An array of objects that contains detailed information about each employer, including the employer's name. |

        The **weeksContributed** object has the following children:

        | Property                     | Description                                                                                     |
        |------------------------------|-------------------------------------------------------------------------------------------------|
        | totalContributedWeeks        | The total number of weeks the individual has contributed to their employment.                  |
        | discountedWeeks              | The number of weeks that have been discounted from the total contributions.                    |
        | reinstatedWeeks              | The number of weeks that have been reinstated after being previously discounted.               |

        **Understanding Working History Detail Object:**

        The **workingHistoryDetail** array contains detailed records for each employer the individual has worked for. Each object in this array includes the following properties:

        | Property                     | Description                                                                                     |
        |------------------------------|-------------------------------------------------------------------------------------------------|
        | employerName                 | The name of the employer for the employment record.                                            |
        | employerRegister             | Number or password assigned by the IMSS, to a employer, when it was registered in the institute (registro del patron)                                           |
        | federalEntity                | Name of location of employer.                                                                    |
        | position                     | The job title or position held by the individual at the employer.                               |
        | startDate                    | The date when the individual started working for the employer.                                  |
        | endDate                      | The date when the individual stopped working for the employer.                                  |
        | lastContributionBaseSalary                      | The salary or wage received by the individual during their employment.                          |
        | workStatusEvents             | Array of events inside of same employer                                     |
        | currency                 | The actual currency for the given salary amounts                                            |

      operationId: getEmploymentVerificationv3
      parameters:
        - name: x-api-key
          in: header
          description: The Consumer Key assigned to the application you have registered in API Hub.
          required: true
          schema:
            type: string
        - name: username
          in: header
          description: Username of the inquiry user.
          required: true
          schema:
            type: string
        - name: password
          in: header
          description: Password of the inquiry user.
          required: true
          schema:
            type: string
        - name: inquiryId
          in: path
          description: The identifier of the inquiry.
          required: true
          schema:
            type: string
        - name: x-signature
          in: header
          description: The signature (X-Signature) is generated using your private key (SHA256withECDSA - secp384r) by signing only the UUID (inquiryId) included in the GET request path.  The API Hub verifies the X-Signature against the URL using your public key, which must be registered in the applications section of the API Hub portal.
          required: true
          schema:
            type: string
        
            
      responses:
        '200':
          description: OK - Returns the employment verification process information with predictive models support, enhanced analytics and time booster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessEVConsumptionIMSSPredictiveModels'
              examples:
                Employment-Stability-Index:
                  summary: Employment Verification with Predictive Models
                  description: An example response of employment verification with predictive models including Stability Index  and EV Credit Score.
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        extractionType: Internal Data Source
                        minimumRecencyDays: 60
                        dataExtractionDate: 2024-11-15 16:41:20
                        predictiveModels: true
                        enhancedAnalytics: false
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: Name
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045
                            currency: "MXN"
                    predictiveModels:
                      employmentStabilityIndex:
                        result: 'nivel_1'
                      EVCreditScore:
                        result: 524
                        
                Enhanced-Analytics:
                  summary: Employment Verification with  Enhanced Analytics
                  description: An example response of employment verificacion with only Enhanced Analytics requested
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        extractionType: External Data Source
                        minimumRecencyDays: 60
                        dataExtractionDate: 2024-11-15 16:41:20
                        predictiveModels: false
                        enhancedAnalytics: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: Name
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045
                    enhancedAnalytics:
                      type1:
                        diasDeContratacion:
                          cDiasDeContratacion: 9
                          diasDeContratacionMax: 1541
                          diasDeContratacionMean: 524
                          diasDeContratacionMedian: 395
                          diasDeContratacionMin: 6
                          diasDeContratacionStd: 487.95
                        lifetimeEarnings: 5023045.76
                        maxBaseSalary:
                          cMaxBaseSalary: 9
                          maxBaseSalaryMax: 2714.25
                          maxBaseSalaryMean: 627.23
                          maxBaseSalaryMedian: 89.89
                          maxBaseSalaryMin: 66.79
                          maxBaseSalaryStd: 995.64
                        netIncome:
                          cNetIncome: 12
                          netIncomeMax: 2714.25
                          netIncomeMean: 455.44
                          netIncomeMedian: 77.81
                          netIncomeMin: 0
                          netIncomeStd: 910.91
                        netIncomeHistorico:
                          - duration: 485
                            employmentStatus: employed
                            endDate: '2024-07-03'
                            event: 12
                            netIncome: 2714.25
                            startDate: '2023-03-06'
                          - duration: 7
                            employmentStatus: employed
                            endDate: '2006-01-02'
                            event: 1
                            netIncome: 66.79
                            startDate: '2005-12-26'
                        pctIncrementoBaseSalary:
                          cPctIncrementoBaseSalary: 8
                          pctIncrementoBaseSalaryMax: 97.13
                          pctIncrementoBaseSalaryMean: -11.32
                          pctIncrementoBaseSalaryMedian: -8.73
                          pctIncrementoBaseSalaryMin: -96.03
                          pctIncrementoBaseSalaryStd: 51.22
                      type2:
                        diasDeContratacion: 485
                        nbDistinctEmployers: 8
                        pctSemanasCotizadas: 100
                        pctSemanasDescontadas: 0
                        totalSalaryDecreases: 2
                        totalSemanas: 675
                        
                Enhanced-Analytics-Predictive-Models:
                  summary: Employment Verification with Enhanced Analytics and Predictive Models
                  description: An example response of employment verificacion with Enhanced Analytics and Predictive Models requested
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        extractionType: External Data Source
                        minimumRecencyDays: 60
                        dataExtractionDate: 2024-11-15 16:41:20
                        predictiveModels: false
                        enhancedAnalytics: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: Name
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045
                    enhancedAnalytics:
                      type1:
                        diasDeContratacion:
                          cDiasDeContratacion: 9
                          diasDeContratacionMax: 1541
                          diasDeContratacionMean: 524
                          diasDeContratacionMedian: 395
                          diasDeContratacionMin: 6
                          diasDeContratacionStd: 487.95
                        lifetimeEarnings: 5023045.76
                        maxBaseSalary:
                          cMaxBaseSalary: 9
                          maxBaseSalaryMax: 2714.25
                          maxBaseSalaryMean: 627.23
                          maxBaseSalaryMedian: 89.89
                          maxBaseSalaryMin: 66.79
                          maxBaseSalaryStd: 995.64
                        netIncome:
                          cNetIncome: 12
                          netIncomeMax: 2714.25
                          netIncomeMean: 455.44
                          netIncomeMedian: 77.81
                          netIncomeMin: 0
                          netIncomeStd: 910.91
                        netIncomeHistorico:
                          - duration: 485
                            employmentStatus: employed
                            endDate: '2024-07-03'
                            event: 12
                            netIncome: 2714.25
                            startDate: '2023-03-06'
                          - duration: 7
                            employmentStatus: employed
                            endDate: '2006-01-02'
                            event: 1
                            netIncome: 66.79
                            startDate: '2005-12-26'
                        pctIncrementoBaseSalary:
                          cPctIncrementoBaseSalary: 8
                          pctIncrementoBaseSalaryMax: 97.13
                          pctIncrementoBaseSalaryMean: -11.32
                          pctIncrementoBaseSalaryMedian: -8.73
                          pctIncrementoBaseSalaryMin: -96.03
                          pctIncrementoBaseSalaryStd: 51.22
                      type2:
                        diasDeContratacion: 485
                        nbDistinctEmployers: 8
                        pctSemanasCotizadas: 100
                        pctSemanasDescontadas: 0
                        totalSalaryDecreases: 2
                        totalSemanas: 675
                    predictiveModels:
                      employmentStabilityIndex:
                        result: 'nivel_1'
                      EVCreditScore:
                        result: 524
                        
                Employment-Stability-Index-Extended-Analytics:
                  summary: Employment Verification with Predictive Models and Extended Analytics
                  description: An example response of employment verification with predictive models including Stability Index, EV Credit Score and Extended Analytics.
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        extractionType: Internal Data Source
                        minimumRecencyDays: 60
                        dataExtractionDate: 2024-11-15 16:41:20
                        predictiveModels: true
                        enhancedAnalytics: false
                        extendedAnalytics: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: Name
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045
                            currency: "MXN"
                    extendedAnalytics:
                      jobStability:
                        PersonAverageNewJobsPerYearCount: 1
                        PersonAverageUniqueEmployersPerYearCount: 1
                        PersonMaximumNewJobsPerYearCount: 3
                        PersonMaximumUniqueEmployersPerYearCount: 2
                        PersonTotalNewJobsCount: 5
                        PersonTotalUniqueEmployeersCount: 5
                        PersonWorkingLifetimeRatioPercentage: 1.06
                        WorkHistorAverageDurationMonths: 31.76
                        WorkHistoryMaximumDurationMonths: 95.37
                        WorkHistoryMinimumDurationMonths: 0.63
                        WorkHistoryTotalDurationMonths: 158.8
                      lastJob:
                        LastJobAverageRatioPercentage: 61.08
                        LastJobDurationDays: 582
                        LastJobDurationMonths: 19.4
                        LastJobEndDateDate: "1900-01-01"
                        LastJobMaximumRatioPercentage: 20.34
                        LastJobStartAgeDecile: "90 - 100"
                        LastJobStartAgeYears: 52
                        LastJobStartDateDate: "2023-07-31"
                        LastJobTotalRatioPercentage: 4.68
                        LastJobWorkHistoryRatioPercentage: 12.22
                      person:
                        PersonAgeDecile: "80 - 90"
                        PersonAgeYears: 54
                        PersonWorkingStatusFlag: 1
                      unemployment:
                        LastUnemploymentAverageRatioPercentage: 251.61
                        LastUnemploymentDurationDays: 4836
                        LastUnemploymentDurationMonths: 161.2
                        LastUnemploymentMaximumRatioPercentage: 100.0
                        LastUnemploymentStartDateDate: "2010-05-04"
                        LastUnemploymentTotalRatioPercentage: 38.88
                        LastUnemploymentWorkHistoryRatioPercentage: 62.9
                        PersonAverageUnemploymentPeriodMonths: 64.07
                        PersonMaximumUnemploymentPeriodMonths: 161.2
                        PersonMinimumUnemploymentPeriodMonths: 0.0
                        PersonTotalUnemploymentDecile: "90 - 100"
                        PersonTotalUnemploymentMonths: 256.27
                      wage:
                        LastJobDailyWageAmount: 293.11
                        LastJobMonthlyWageAmount: 8793.3
                        PersonAverageDailyNetIncomeAmount: 200.42
                        PersonLast3YearsDailyAverageNetIncomeAmount: 258.39
                        PersonLast3YearsDailyMaximumNetIncomeAmount: 293.11
                        PersonLast3YearsMinimumNetIncomeAmount: 217.85
                        PersonLast3YearsTotalNetIncomeAmount: 147385.72
                        PersonLast5YearsDailyAverageNetIncomeAmount: 258.39
                        PersonLast5YearsDailyMaximumNetIncomeAmount: 293.11
                        PersonLast5YearsMinimumNetIncomeAmount: 217.85
                        PersonLast5YearsTotalNetIncomeAmount: 147385.72
                        PersonLastYearDailyAverageNetIncomeAmount: 277.25
                        PersonLastYearDailyMaximumNetIncomeAmount: 293.11
                        PersonLastYearMinimumNetIncomeAmount: 261.38
                        PersonLastYearTotalNetIncomeAmount: 97370.96
                        PersonMaximumDailyNetIncomeAmount: 327.91
                        PersonMinimumDailyNetIncomeAmount: 10.36
                        PersonTotalNetIncomeAmount: 1001983.94
                        WageChangeFirstLastPercentage: 2729.25
                        WorkHistoryAverageWageIncrementPercentage: 19.2
                        WorkHistoryMaximumWageIncrementPercentage: 376.06
                        WorkHistoryMinimumWageIncrementPercentage: 0.07
                      workingContinuity:
                        LastContinuousContributionPeriodAverageRatioPercentage: 61.08
                        LastContinuousContributionPeriodDurationDays: 582
                        LastContinuousContributionPeriodDurationDecile: "20 - 30"
                        LastContinuousContributionPeriodDurationMonths: 19.4
                        LastContinuousContributionPeriodDurationWeeks: 83.14
                        LastContinuousContributionPeriodDurationYears: 1.59
                        LastContinuousContributionPeriodHistoryRatioPercentage: 12.22
                        LastContinuousContributionPeriodMaximumRatioPercentage: 20.34
                        LastContinuousContributionPeriodStartDateDate: "2023-07-31"
                        LastContinuousContributionPeriodTotalRatioPercentage: 4.68
                      workingLifetime:
                        PersonAdultWorkingLifetimeYears: 36.08
                        PersonAverageMonthsWithMultipleJobsCount: 0.5
                        PersonMaximumMonthsWithMultipleJobsCount: 0.5
                        PersonMaximumMultipleJobsCount: 1
                        PersonTotalMonthsWithMultipleJobsCount: 0.5
                        PersonWorkingAgeYears: 34.07
                        PersonWorkingLifetimeDays: 12437
                        PersonWorkingLifetimeDecile: "90 - 100"
                        PersonWorkingLifetimeMonths: 414.57
                        PersonWorkingLifetimeWeeks: 1776.71
                        PersonWorkingStartAgeQuartile: "0 - 25"
                        PersonWorkingStartAgeYears: 20
                        PersonWorkingStartDateDate: "1991-02-14"
                        WorkingHistoryAvgDays: 952.8
                        WorkingHistoryMaxDays: 2861
                        WorkingHistoryMinDays: 19
                        WorkingHistoryTotalDays: 4764
                    predictiveModels:
                      employmentStabilityIndex:
                        result: 'nivel_1'
                      EVCreditScore:
                        result: 524
                        
                Enhanced-Analytics-Extended-Analytics:
                  summary: Employment Verification with  Enhanced Analytics and Extended Analytics
                  description: An example response of employment verification with Enhanced Analytics requested and extended analytics included.
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        extractionType: External Data Source
                        minimumRecencyDays: 60
                        dataExtractionDate: 2024-11-15 16:41:20
                        predictiveModels: false
                        enhancedAnalytics: true
                        extendedAnalytics: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: Name
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045
                    enhancedAnalytics:
                      type1:
                        diasDeContratacion:
                          cDiasDeContratacion: 9
                          diasDeContratacionMax: 1541
                          diasDeContratacionMean: 524
                          diasDeContratacionMedian: 395
                          diasDeContratacionMin: 6
                          diasDeContratacionStd: 487.95
                        lifetimeEarnings: 5023045.76
                        maxBaseSalary:
                          cMaxBaseSalary: 9
                          maxBaseSalaryMax: 2714.25
                          maxBaseSalaryMean: 627.23
                          maxBaseSalaryMedian: 89.89
                          maxBaseSalaryMin: 66.79
                          maxBaseSalaryStd: 995.64
                        netIncome:
                          cNetIncome: 12
                          netIncomeMax: 2714.25
                          netIncomeMean: 455.44
                          netIncomeMedian: 77.81
                          netIncomeMin: 0
                          netIncomeStd: 910.91
                        netIncomeHistorico:
                          - duration: 485
                            employmentStatus: employed
                            endDate: '2024-07-03'
                            event: 12
                            netIncome: 2714.25
                            startDate: '2023-03-06'
                          - duration: 7
                            employmentStatus: employed
                            endDate: '2006-01-02'
                            event: 1
                            netIncome: 66.79
                            startDate: '2005-12-26'
                        pctIncrementoBaseSalary:
                          cPctIncrementoBaseSalary: 8
                          pctIncrementoBaseSalaryMax: 97.13
                          pctIncrementoBaseSalaryMean: -11.32
                          pctIncrementoBaseSalaryMedian: -8.73
                          pctIncrementoBaseSalaryMin: -96.03
                          pctIncrementoBaseSalaryStd: 51.22
                      type2:
                        diasDeContratacion: 485
                        nbDistinctEmployers: 8
                        pctSemanasCotizadas: 100
                        pctSemanasDescontadas: 0
                        totalSalaryDecreases: 2
                        totalSemanas: 675
                    extendedAnalytics:
                      jobStability:
                        PersonAverageNewJobsPerYearCount: 1
                        PersonAverageUniqueEmployersPerYearCount: 1
                        PersonMaximumNewJobsPerYearCount: 3
                        PersonMaximumUniqueEmployersPerYearCount: 2
                        PersonTotalNewJobsCount: 5
                        PersonTotalUniqueEmployeersCount: 5
                        PersonWorkingLifetimeRatioPercentage: 1.06
                        WorkHistorAverageDurationMonths: 31.76
                        WorkHistoryMaximumDurationMonths: 95.37
                        WorkHistoryMinimumDurationMonths: 0.63
                        WorkHistoryTotalDurationMonths: 158.8
                      lastJob:
                        LastJobAverageRatioPercentage: 61.08
                        LastJobDurationDays: 582
                        LastJobDurationMonths: 19.4
                        LastJobEndDateDate: "1900-01-01"
                        LastJobMaximumRatioPercentage: 20.34
                        LastJobStartAgeDecile: "90 - 100"
                        LastJobStartAgeYears: 52
                        LastJobStartDateDate: "2023-07-31"
                        LastJobTotalRatioPercentage: 4.68
                        LastJobWorkHistoryRatioPercentage: 12.22
                      person:
                        PersonAgeDecile: "80 - 90"
                        PersonAgeYears: 54
                        PersonWorkingStatusFlag: 1
                      unemployment:
                        LastUnemploymentAverageRatioPercentage: 251.61
                        LastUnemploymentDurationDays: 4836
                        LastUnemploymentDurationMonths: 161.2
                        LastUnemploymentMaximumRatioPercentage: 100.0
                        LastUnemploymentStartDateDate: "2010-05-04"
                        LastUnemploymentTotalRatioPercentage: 38.88
                        LastUnemploymentWorkHistoryRatioPercentage: 62.9
                        PersonAverageUnemploymentPeriodMonths: 64.07
                        PersonMaximumUnemploymentPeriodMonths: 161.2
                        PersonMinimumUnemploymentPeriodMonths: 0.0
                        PersonTotalUnemploymentDecile: "90 - 100"
                        PersonTotalUnemploymentMonths: 256.27
                      wage:
                        LastJobDailyWageAmount: 293.11
                        LastJobMonthlyWageAmount: 8793.3
                        PersonAverageDailyNetIncomeAmount: 200.42
                        PersonLast3YearsDailyAverageNetIncomeAmount: 258.39
                        PersonLast3YearsDailyMaximumNetIncomeAmount: 293.11
                        PersonLast3YearsMinimumNetIncomeAmount: 217.85
                        PersonLast3YearsTotalNetIncomeAmount: 147385.72
                        PersonLast5YearsDailyAverageNetIncomeAmount: 258.39
                        PersonLast5YearsDailyMaximumNetIncomeAmount: 293.11
                        PersonLast5YearsMinimumNetIncomeAmount: 217.85
                        PersonLast5YearsTotalNetIncomeAmount: 147385.72
                        PersonLastYearDailyAverageNetIncomeAmount: 277.25
                        PersonLastYearDailyMaximumNetIncomeAmount: 293.11
                        PersonLastYearMinimumNetIncomeAmount: 261.38
                        PersonLastYearTotalNetIncomeAmount: 97370.96
                        PersonMaximumDailyNetIncomeAmount: 327.91
                        PersonMinimumDailyNetIncomeAmount: 10.36
                        PersonTotalNetIncomeAmount: 1001983.94
                        WageChangeFirstLastPercentage: 2729.25
                        WorkHistoryAverageWageIncrementPercentage: 19.2
                        WorkHistoryMaximumWageIncrementPercentage: 376.06
                        WorkHistoryMinimumWageIncrementPercentage: 0.07
                      workingContinuity:
                        LastContinuousContributionPeriodAverageRatioPercentage: 61.08
                        LastContinuousContributionPeriodDurationDays: 582
                        LastContinuousContributionPeriodDurationDecile: "20 - 30"
                        LastContinuousContributionPeriodDurationMonths: 19.4
                        LastContinuousContributionPeriodDurationWeeks: 83.14
                        LastContinuousContributionPeriodDurationYears: 1.59
                        LastContinuousContributionPeriodHistoryRatioPercentage: 12.22
                        LastContinuousContributionPeriodMaximumRatioPercentage: 20.34
                        LastContinuousContributionPeriodStartDateDate: "2023-07-31"
                        LastContinuousContributionPeriodTotalRatioPercentage: 4.68
                      workingLifetime:
                        PersonAdultWorkingLifetimeYears: 36.08
                        PersonAverageMonthsWithMultipleJobsCount: 0.5
                        PersonMaximumMonthsWithMultipleJobsCount: 0.5
                        PersonMaximumMultipleJobsCount: 1
                        PersonTotalMonthsWithMultipleJobsCount: 0.5
                        PersonWorkingAgeYears: 34.07
                        PersonWorkingLifetimeDays: 12437
                        PersonWorkingLifetimeDecile: "90 - 100"
                        PersonWorkingLifetimeMonths: 414.57
                        PersonWorkingLifetimeWeeks: 1776.71
                        PersonWorkingStartAgeQuartile: "0 - 25"
                        PersonWorkingStartAgeYears: 20
                        PersonWorkingStartDateDate: "1991-02-14"
                        WorkingHistoryAvgDays: 952.8
                        WorkingHistoryMaxDays: 2861
                        WorkingHistoryMinDays: 19
                        WorkingHistoryTotalDays: 4764

                Enhanced-Analytics-Predictive-Models-Extended-Analytics:
                  summary: Employment Verification with Enhanced Analytics, Predictive Models and Extended Analytics
                  description: An example response of employment verification with Enhanced Analytics, Predictive Models requested, and Extended Analytics included.
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        extractionType: External Data Source
                        minimumRecencyDays: 60
                        dataExtractionDate: 2024-11-15 16:41:20
                        predictiveModels: true
                        enhancedAnalytics: true
                        extendedAnalytics: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: Name
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045
                    enhancedAnalytics:
                      type1:
                        diasDeContratacion:
                          cDiasDeContratacion: 9
                          diasDeContratacionMax: 1541
                          diasDeContratacionMean: 524
                          diasDeContratacionMedian: 395
                          diasDeContratacionMin: 6
                          diasDeContratacionStd: 487.95
                        lifetimeEarnings: 5023045.76
                        maxBaseSalary:
                          cMaxBaseSalary: 9
                          maxBaseSalaryMax: 2714.25
                          maxBaseSalaryMean: 627.23
                          maxBaseSalaryMedian: 89.89
                          maxBaseSalaryMin: 66.79
                          maxBaseSalaryStd: 995.64
                        netIncome:
                          cNetIncome: 12
                          netIncomeMax: 2714.25
                          netIncomeMean: 455.44
                          netIncomeMedian: 77.81
                          netIncomeMin: 0
                          netIncomeStd: 910.91
                        netIncomeHistorico:
                          - duration: 485
                            employmentStatus: employed
                            endDate: '2024-07-03'
                            event: 12
                            netIncome: 2714.25
                            startDate: '2023-03-06'
                          - duration: 7
                            employmentStatus: employed
                            endDate: '2006-01-02'
                            event: 1
                            netIncome: 66.79
                            startDate: '2005-12-26'
                        pctIncrementoBaseSalary:
                          cPctIncrementoBaseSalary: 8
                          pctIncrementoBaseSalaryMax: 97.13
                          pctIncrementoBaseSalaryMean: -11.32
                          pctIncrementoBaseSalaryMedian: -8.73
                          pctIncrementoBaseSalaryMin: -96.03
                          pctIncrementoBaseSalaryStd: 51.22
                      type2:
                        diasDeContratacion: 485
                        nbDistinctEmployers: 8
                        pctSemanasCotizadas: 100
                        pctSemanasDescontadas: 0
                        totalSalaryDecreases: 2
                        totalSemanas: 675
                    extendedAnalytics:
                      jobStability:
                        PersonAverageNewJobsPerYearCount: 1
                        PersonAverageUniqueEmployersPerYearCount: 1
                        PersonMaximumNewJobsPerYearCount: 3
                        PersonMaximumUniqueEmployersPerYearCount: 2
                        PersonTotalNewJobsCount: 5
                        PersonTotalUniqueEmployeersCount: 5
                        PersonWorkingLifetimeRatioPercentage: 1.06
                        WorkHistorAverageDurationMonths: 31.76
                        WorkHistoryMaximumDurationMonths: 95.37
                        WorkHistoryMinimumDurationMonths: 0.63
                        WorkHistoryTotalDurationMonths: 158.8
                      lastJob:
                        LastJobAverageRatioPercentage: 61.08
                        LastJobDurationDays: 582
                        LastJobDurationMonths: 19.4
                        LastJobEndDateDate: "1900-01-01"
                        LastJobMaximumRatioPercentage: 20.34
                        LastJobStartAgeDecile: "90 - 100"
                        LastJobStartAgeYears: 52
                        LastJobStartDateDate: "2023-07-31"
                        LastJobTotalRatioPercentage: 4.68
                        LastJobWorkHistoryRatioPercentage: 12.22
                      person:
                        PersonAgeDecile: "80 - 90"
                        PersonAgeYears: 54
                        PersonWorkingStatusFlag: 1
                      unemployment:
                        LastUnemploymentAverageRatioPercentage: 251.61
                        LastUnemploymentDurationDays: 4836
                        LastUnemploymentDurationMonths: 161.2
                        LastUnemploymentMaximumRatioPercentage: 100.0
                        LastUnemploymentStartDateDate: "2010-05-04"
                        LastUnemploymentTotalRatioPercentage: 38.88
                        LastUnemploymentWorkHistoryRatioPercentage: 62.9
                        PersonAverageUnemploymentPeriodMonths: 64.07
                        PersonMaximumUnemploymentPeriodMonths: 161.2
                        PersonMinimumUnemploymentPeriodMonths: 0.0
                        PersonTotalUnemploymentDecile: "90 - 100"
                        PersonTotalUnemploymentMonths: 256.27
                      wage:
                        LastJobDailyWageAmount: 293.11
                        LastJobMonthlyWageAmount: 8793.3
                        PersonAverageDailyNetIncomeAmount: 200.42
                        PersonLast3YearsDailyAverageNetIncomeAmount: 258.39
                        PersonLast3YearsDailyMaximumNetIncomeAmount: 293.11
                        PersonLast3YearsMinimumNetIncomeAmount: 217.85
                        PersonLast3YearsTotalNetIncomeAmount: 147385.72
                        PersonLast5YearsDailyAverageNetIncomeAmount: 258.39
                        PersonLast5YearsDailyMaximumNetIncomeAmount: 293.11
                        PersonLast5YearsMinimumNetIncomeAmount: 217.85
                        PersonLast5YearsTotalNetIncomeAmount: 147385.72
                        PersonLastYearDailyAverageNetIncomeAmount: 277.25
                        PersonLastYearDailyMaximumNetIncomeAmount: 293.11
                        PersonLastYearMinimumNetIncomeAmount: 261.38
                        PersonLastYearTotalNetIncomeAmount: 97370.96
                        PersonMaximumDailyNetIncomeAmount: 327.91
                        PersonMinimumDailyNetIncomeAmount: 10.36
                        PersonTotalNetIncomeAmount: 1001983.94
                        WageChangeFirstLastPercentage: 2729.25
                        WorkHistoryAverageWageIncrementPercentage: 19.2
                        WorkHistoryMaximumWageIncrementPercentage: 376.06
                        WorkHistoryMinimumWageIncrementPercentage: 0.07
                      workingContinuity:
                        LastContinuousContributionPeriodAverageRatioPercentage: 61.08
                        LastContinuousContributionPeriodDurationDays: 582
                        LastContinuousContributionPeriodDurationDecile: "20 - 30"
                        LastContinuousContributionPeriodDurationMonths: 19.4
                        LastContinuousContributionPeriodDurationWeeks: 83.14
                        LastContinuousContributionPeriodDurationYears: 1.59
                        LastContinuousContributionPeriodHistoryRatioPercentage: 12.22
                        LastContinuousContributionPeriodMaximumRatioPercentage: 20.34
                        LastContinuousContributionPeriodStartDateDate: "2023-07-31"
                        LastContinuousContributionPeriodTotalRatioPercentage: 4.68
                      workingLifetime:
                        PersonAdultWorkingLifetimeYears: 36.08
                        PersonAverageMonthsWithMultipleJobsCount: 0.5
                        PersonMaximumMonthsWithMultipleJobsCount: 0.5
                        PersonMaximumMultipleJobsCount: 1
                        PersonTotalMonthsWithMultipleJobsCount: 0.5
                        PersonWorkingAgeYears: 34.07
                        PersonWorkingLifetimeDays: 12437
                        PersonWorkingLifetimeDecile: "90 - 100"
                        PersonWorkingLifetimeMonths: 414.57
                        PersonWorkingLifetimeWeeks: 1776.71
                        PersonWorkingStartAgeQuartile: "0 - 25"
                        PersonWorkingStartAgeYears: 20
                        PersonWorkingStartDateDate: "1991-02-14"
                        WorkingHistoryAvgDays: 952.8
                        WorkingHistoryMaxDays: 2861
                        WorkingHistoryMinDays: 19
                        WorkingHistoryTotalDays: 4764
                    predictiveModels:
                      employmentStabilityIndex:
                        result: 'nivel_1'
                      EVCreditScore:
                        result: 524
                
                Extended-Analytics:
                  summary: Employment Verification with  Extended Analytics
                  description: An example response of employment verificacion with only Extended Analytics requested
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        extractionType: External Data Source
                        minimumRecencyDays: 60
                        dataExtractionDate: 2024-11-15 16:41:20
                        predictiveModels: false
                        enhancedAnalytics: false
                        extendedAnalytics: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail:
                          - employerName: Name
                            employerRegister: 1234567
                            federalEntity: CDMX
                            startDate: '2022-12-27'
                            endDate: '2022-12-27'
                            lastContributionBaseSalary: 0
                            workStatusEvents:
                              - changeType: 2
                                eventDate: '2022-12-27'
                                baseSalary: 10045
                    extendedAnalytics:
                      jobStability:
                        PersonAverageNewJobsPerYearCount: 1
                        PersonAverageUniqueEmployersPerYearCount: 1
                        PersonMaximumNewJobsPerYearCount: 3
                        PersonMaximumUniqueEmployersPerYearCount: 2
                        PersonTotalNewJobsCount: 5
                        PersonTotalUniqueEmployeersCount: 5
                        PersonWorkingLifetimeRatioPercentage: 1.06
                        WorkHistorAverageDurationMonths: 31.76
                        WorkHistoryMaximumDurationMonths: 95.37
                        WorkHistoryMinimumDurationMonths: 0.63
                        WorkHistoryTotalDurationMonths: 158.8
                      lastJob:
                        LastJobAverageRatioPercentage: 61.08
                        LastJobDurationDays: 582
                        LastJobDurationMonths: 19.4
                        LastJobEndDateDate: "1900-01-01"
                        LastJobMaximumRatioPercentage: 20.34
                        LastJobStartAgeDecile: "90 - 100"
                        LastJobStartAgeYears: 52
                        LastJobStartDateDate: "2023-07-31"
                        LastJobTotalRatioPercentage: 4.68
                        LastJobWorkHistoryRatioPercentage: 12.22
                      person:
                        PersonAgeDecile: "80 - 90"
                        PersonAgeYears: 54
                        PersonWorkingStatusFlag: 1
                      unemployment:
                        LastUnemploymentAverageRatioPercentage: 251.61
                        LastUnemploymentDurationDays: 4836
                        LastUnemploymentDurationMonths: 161.2
                        LastUnemploymentMaximumRatioPercentage: 100.0
                        LastUnemploymentStartDateDate: "2010-05-04"
                        LastUnemploymentTotalRatioPercentage: 38.88
                        LastUnemploymentWorkHistoryRatioPercentage: 62.9
                        PersonAverageUnemploymentPeriodMonths: 64.07
                        PersonMaximumUnemploymentPeriodMonths: 161.2
                        PersonMinimumUnemploymentPeriodMonths: 0.0
                        PersonTotalUnemploymentDecile: "90 - 100"
                        PersonTotalUnemploymentMonths: 256.27
                      wage:
                        LastJobDailyWageAmount: 293.11
                        LastJobMonthlyWageAmount: 8793.3
                        PersonAverageDailyNetIncomeAmount: 200.42
                        PersonLast3YearsDailyAverageNetIncomeAmount: 258.39
                        PersonLast3YearsDailyMaximumNetIncomeAmount: 293.11
                        PersonLast3YearsMinimumNetIncomeAmount: 217.85
                        PersonLast3YearsTotalNetIncomeAmount: 147385.72
                        PersonLast5YearsDailyAverageNetIncomeAmount: 258.39
                        PersonLast5YearsDailyMaximumNetIncomeAmount: 293.11
                        PersonLast5YearsMinimumNetIncomeAmount: 217.85
                        PersonLast5YearsTotalNetIncomeAmount: 147385.72
                        PersonLastYearDailyAverageNetIncomeAmount: 277.25
                        PersonLastYearDailyMaximumNetIncomeAmount: 293.11
                        PersonLastYearMinimumNetIncomeAmount: 261.38
                        PersonLastYearTotalNetIncomeAmount: 97370.96
                        PersonMaximumDailyNetIncomeAmount: 327.91
                        PersonMinimumDailyNetIncomeAmount: 10.36
                        PersonTotalNetIncomeAmount: 1001983.94
                        WageChangeFirstLastPercentage: 2729.25
                        WorkHistoryAverageWageIncrementPercentage: 19.2
                        WorkHistoryMaximumWageIncrementPercentage: 376.06
                        WorkHistoryMinimumWageIncrementPercentage: 0.07
                      workingContinuity:
                        LastContinuousContributionPeriodAverageRatioPercentage: 61.08
                        LastContinuousContributionPeriodDurationDays: 582
                        LastContinuousContributionPeriodDurationDecile: "20 - 30"
                        LastContinuousContributionPeriodDurationMonths: 19.4
                        LastContinuousContributionPeriodDurationWeeks: 83.14
                        LastContinuousContributionPeriodDurationYears: 1.59
                        LastContinuousContributionPeriodHistoryRatioPercentage: 12.22
                        LastContinuousContributionPeriodMaximumRatioPercentage: 20.34
                        LastContinuousContributionPeriodStartDateDate: "2023-07-31"
                        LastContinuousContributionPeriodTotalRatioPercentage: 4.68
                      workingLifetime:
                        PersonAdultWorkingLifetimeYears: 36.08
                        PersonAverageMonthsWithMultipleJobsCount: 0.5
                        PersonMaximumMonthsWithMultipleJobsCount: 0.5
                        PersonMaximumMultipleJobsCount: 1
                        PersonTotalMonthsWithMultipleJobsCount: 0.5
                        PersonWorkingAgeYears: 34.07
                        PersonWorkingLifetimeDays: 12437
                        PersonWorkingLifetimeDecile: "90 - 100"
                        PersonWorkingLifetimeMonths: 414.57
                        PersonWorkingLifetimeWeeks: 1776.71
                        PersonWorkingStartAgeQuartile: "0 - 25"
                        PersonWorkingStartAgeYears: 20
                        PersonWorkingStartDateDate: "1991-02-14"
                        WorkingHistoryAvgDays: 952.8
                        WorkingHistoryMaxDays: 2861
                        WorkingHistoryMinDays: 19
                        WorkingHistoryTotalDays: 4764
                
                Not-working-history:
                  summary: Employment Verification for an Individual with No Employment History
                  description: This response illustrates a scenario where the individual is registered in the IMSS database but has never been employed. It provides details on the employment verification process for such cases.
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: '2020-04-12T22:20:50.52Z'
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        subscriptionId: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
                        inquiryId: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
                        curp: BADD110313HCMLNS09
                        email: api@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: true
                        enhancedAnalytics: true
                        predictiveModels: true
                      names: VICENTE RAMON GUERRERO SALDAÑA
                      birthday: '1829-04-01'
                      workStatus: W
                      validUntil: '1829-04-01'
                      workingHistory:
                        date: '2022-12-27'
                        weeksContributed:
                          totalContributedWeeks: 0
                          discountedWeeks: 0
                          reinstatedWeeks: 0
                        workingHistoryDetail: []
                      enhancedAnalytics:
                        type1: null
                        type2: null
                      predictiveModels:
                        employmentStabilityIndex:
                          result: null
                        EVCreditScore: null

        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '400.1'
                    message: 'Incident ID: 1817000210222690579-404000433340358779'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '401.2'
                    message: 'Unauthorized, invalid credentials.'
                  - code: '401.3'
                    message: 'Unauthorized, you do not have the product.'
                  - code: '401.4'
                    message: 'Unauthorized, you do not have access to the resource.'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '403.1'
                    message: 'We could not verify the signature, x-signature is invalid'
        '404':
          description: Inquiry not found or and error with the verification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckFailureEVConsumption'
              example:
                acknowledgeId: 45f53c81-04e0-42df-abd8-de217e2edf2a
                dateTime: '2020-09-01T03:36:38Z'
                operation: consume
                message: The request has been consumed.
                employmentVerification:
                  errors:
                  - code: "404"
                    message: The inquiry does not exist.
                  - code: "404.1"
                    message: The data in the IMSS database have inconsistencies.
                  - code: "404.2"
                    message: The email is already associated with another CURP.
                  - code: "404.3"
                    message: The person does not have NSS.
                  - code: "404.4"
                    message: The CURP was not found in the external entity (RENAPO)
                  - code: "404.5"
                    message: The service is not available for this request
                  - code: "404.6"
                    message: Request not found on IMSS and Internal Data Source
        '425':
          description: 'Too early - The employment verification process associated with the {inquiryId} path parameter has not yet been completed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '425.2'
                    message: 'The employment verification process associated with the {inquiryId} path parameter has not yet been completed.'
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '429'
                    message: Too many requests.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckFailureEVConsumption'
              example:
                acknowledgeId: 6a2224ec-1e48-4bbd-ba2c-1971dd783735
                dateTime: '2020-09-01T05:32:41Z'
                operation: consume
                message: The request has been consumed.
                employmentVerification:
                  errors:
                    - code: '500'
                      message: 'There was an unexpected error, try again later.'
                    - code: '500.2'
                      message: 'The request could not be processed.'
                    - code: '500.3'
                      message: 'The request could not be delivered.'
        '503':
          description: Service unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                  - code: '503'
                    message: Service unavailable.
components:
  schemas:
    PrivacyNotice:
      required:
        - acceptance
        - acceptanceDate
        - address
        - fullName
      type: object
      properties:
        fullName:
          $ref: '#/components/schemas/FullName'
        address:
          $ref: '#/components/schemas/Address'
        acceptanceDate:
          type: string
          pattern: '^[1-9]\d{3}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{2}Z$'
          description: Date and time of the privacy notice acceptance. As defined by date-time - RFC3339.
          format: date-time
          example: '2020-04-12T22:20:50.52Z'
        acceptance:
          maxLength: 1
          minLength: 1
          type: string
          description: Y if the Customer has accepted the privacy notice otherwise these field must be N.
          enum:
            - 'Y'
            - 'N'
      description: The privacy notice the Customer must accept.
    FullName:
      required:
        - firstName
        - firstSurname
        - secondSurname
      type: object
      properties:
        firstName:
          maxLength: 50
          minLength: 0
          type: string
          pattern: '^[A-Za-z0-9\s]+$'
          description: Firstname (Nombre).
          example: ROBERTO
        middleName:
          maxLength: 50
          minLength: 0
          nullable: true
          type: string
          description: Middlename (segundo nombre).
        firstSurname:
          maxLength: 30
          minLength: 0
          type: string
          pattern: '^[A-Za-z0-9\s]+$'
          description: First surname (apellido paterno).
          example: SAHAGUN
        secondSurname:
          maxLength: 30
          minLength: 0
          type: string
          pattern: '^[A-Za-z0-9\s]+$'
          description: Second surname (apellido materno).
          example: ZARAGOZA
        aditionalSurname:
          maxLength: 30
          minLength: 0
          nullable: true
          type: string
          description: Additional surname (apellido adicional)
    Address:
      required:
        - city
        - county
        - postalCode
        - settlement
        - state
        - streetAndNumber
      type: object
      properties:
        streetAndNumber:
          maxLength: 85
          minLength: 2
          type: string
          description: Street name and street number (calle y número).
          example: HIDALGO 32
        settlement:
          maxLength: 60
          minLength: 2
          type: string
          description: Settlement (colonia).
          example: CENTRO
        county:
          maxLength: 60
          minLength: 2
          type: string
          description: County (municipio).
          example: LA BARCA
        city:
          maxLength: 40
          minLength: 2
          type: string
          description: City (ciudad).
          example: BENITO JUAREZ
        state:
          $ref: '#/components/schemas/StateCatalog'
        postalCode:
          maxLength: 10
          minLength: 5
          type: string
          description: Postal code (código postal).
          example: '47917'
      description: Customer address.
    StateCatalog:
      maxLength: 4
      minLength: 2
      type: string
      description: State (Estado)<table><thead><tr><th>Identifier</th><th>Name</th></tr></thead><tbody><tr><td>AGS</td><td>AGUASCALIENTES</td></tr><tr><td>BC</td><td>BAJA CALIFORNIA NORTE</td></tr><tr><td>BCS</td><td>BAJA CALIFORNIA SUR</td></tr><tr><td>CAMP</td><td>CAMPECHE</td></tr><tr><td>CDMX</td><td>CIUDAD DE MÉXICO</td></tr><tr><td>CHIS</td><td>CHIAPAS</td></tr><tr><td>CHIH</td><td>CHIHUAHUA</td></tr><tr><td>COAH</td><td>COHAHUILA</td></tr><tr><td>COL</td><td>COLIMA</td></tr><tr><td>DF</td><td>DISTRITO FEDERAL</td></tr><tr><td>DGO</td><td>DURANGO</td></tr><tr><td>GTO</td><td>GUANAJUATO</td></tr><tr><td>GRO</td><td>GUERRERO</td></tr><tr><td>HGO</td><td>HIDALGO</td></tr><tr><td>JAL</td><td>JALISCO</td></tr><tr><td>MEX</td><td>MÉXICO</td></tr><tr><td>MICH</td><td>MICHOCÁN</td></tr><tr><td>MOR</td><td>MORELOS</td></tr><tr><td>NAY</td><td>NAYARIT</td></tr><tr><td>NL</td><td>NUEVO LEÓN</td></tr><tr><td>OAX</td><td>OXACA</td></tr><tr><td>PUE</td><td>PUEBLA</td></tr><tr><td>QRO</td><td>QUERÉTARO</td></tr><tr><td>QROO</td><td>QUINTANA ROO</td></tr><tr><td>SLP</td><td>SAN LUIS POTOSÍ</td></tr><tr><td>SIN</td><td>SINALOA</td></tr><tr><td>SON</td><td>SONORA</td></tr><tr><td>TAB</td><td>TABASCO</td></tr><tr><td>TAMP</td><td>TAMAULIPAS</td></tr><tr><td>TLAX</td><td>TLAXCALA</td></tr><tr><td>VER</td><td>VERACRUZ</td></tr><tr><td>YUC</td><td>YUCATÁN</td></tr><tr><td>ZAC</td><td>ZACATECAS</td></tr></tbody></table>
      example: JAL
      enum:
        - AGS
        - BC
        - BCS
        - CAMP
        - COAH
        - COL
        - CHIS
        - CHIH
        - DF
        - CDMX
        - DGO
        - GTO
        - GRO
        - HGO
        - JAL
        - MEX
        - MICH
        - MOR
        - NAY
        - NL
        - OAX
        - PUE
        - QRO
        - QROO
        - SLP
        - SIN
        - SON
        - TAB
        - TAMPS
        - TLAX
        - VER
        - YUC
        - ZAC
    EmploymentVerificationv1Body:
      required:
        - employmentVerification
        - privacyNotice
      type: object
      properties:
        privacyNotice:
          $ref: '#/components/schemas/PrivacyNotice'
        employmentVerification:
          $ref: '#/components/schemas/EmploymentVerificationSimpleReqObj'
      description: Employment verification information. It must include the the privacy notice customer acceptance.
      
    EmploymentVerificationSimpleReqObj:
      description: Employment verification information
      required:
        - employmentVerificationRequestId
        - subscriptionId
        - curp
        - email
      properties:
        employmentVerificationRequestId:
          type: string
          pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
          description: The identifier of the employment verification request given by the API consumer (UUID).
          format: uuid
          example: 391d151f-1cac-44e7-a05b-79a1199621d6
        subscriptionId:
          type: string
          pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
          description: The API Hub event subscription identifier (UUID). Must be created with Subscriptions API pointing to this event mx.com.circulodecredito.eva
          format: uuid
          example: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
        curp:
          type: string
          minLength: 18
          maxLength: 18
          pattern: '^[A-Z][AEIOUX][A-Z]{2}[0-9]{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])[MH]([ABCMTZ]S|[BCJMOT]C|[CNPST]L|[GNQ]T|[GQS]R|C[MH]|[MY]N|[DH]G|NE|VZ|DF|SP)[BCDFGHJ-NP-TV-Z]{3}[0-9A-Z][0-9]$'
          description: CURP (loan/credit applicant MX Id).
          example: BADD110313HCMLNS09
        email:
          type: string
          minLength: 3
          maxLength: 80
          description: email
          pattern: '^((?:[A-Za-z0-9!*+\-\^_`~]|(?<=^|\.)"|"(=$|\.|@)|(?<=".*)[ .](?=.*")|(?<!\.)\.){1,64})(@)((?:[A-Za-z0-9.\-])*(?:[A-Za-z0-9])\.(?:[A-Za-z0-9]){2,})$'
          example: api@circulodecredito.com.mx
          format: email  
        employmentStabilityIndex:
          type: boolean
          example: true
        processingModel:
          type: string
          description: '"ENRICHED | GATEWAY" (optional, defaults to "ENRICHED" if not specified)'
          enum:
            - GATEWAY
            - ENRICHED
          example: ENRICHED
        waitingTimeout:
          type: integer
          description: '[5, 10, 15, 30*, 60, 120, 180] minutes (optional, defaults to 30 if not specified with "ENRICHED")'
          enum:
            - 5
            - 10
            - 15
            - 30
            - 60
            - 120
            - 180
          example: 10
        enhancedAnalytics:
          type: boolean
          description: Indicates whether to include detailed historical job movement analytics in the response. When set to true, the response will provide comprehensive insights into an individual's employment history, including key statistics such as total days of employment, lifetime earnings, maximum base salary, and net income. Additionally, it will offer a breakdown of employment trends over time, highlighting changes in employment status and salary, as well as the number of distinct employers and the percentage of weeks with social security contributions.
          example: true
    EmploymentVerificationWithPredictiveModelsV3Body:
      required:
        - employmentVerification
        - privacyNotice
      type: object
      properties:
        privacyNotice:
          $ref: '#/components/schemas/PrivacyNotice'
        employmentVerification:
          $ref: '#/components/schemas/EmploymentVerificationModelsObj'
      description: Employment verification information. It must include the the privacy notice customer acceptance.
      
    EmploymentVerificationId:
      type: object
      properties:
        employmentVerificationRequestId:
          maxLength: 36
          minLength: 36
          type: string
          description: The identifier of the employment verification request given by the API consumer (UUID).
          format: uuid
          example: 391d151f-1cac-44e7-a05b-79a1199621d6
        subscriptionId:
          maxLength: 36
          minLength: 36
          type: string
          description: The API Hub event subscription identifier (UUID).
          format: uuid
          example: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
        inquiryId:
          maxLength: 36
          minLength: 36
          type: string
          description: The employment verification process identifier given by Círculo de Crédito.
          format: uuid
          readOnly: true
          example: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
      description: Identifier of the employment verification process.

    EmploymentVerificationModelsObj:
      description: Employment verification information
      required:
        - employmentVerificationRequestId
        - subscriptionId
        - curp
        - email
      properties:
        employmentVerificationRequestId:
          type: string
          pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
          description: The identifier of the employment verification request given by the API consumer (UUID).
          format: uuid
          example: 391d151f-1cac-44e7-a05b-79a1199621d6
        subscriptionId:
          type: string
          pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
          description: The API Hub event subscription identifier (UUID). Must be created with Subscriptions API pointing to this event mx.com.circulodecredito.eva.models
          format: uuid
          example: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
        curp:
          type: string
          minLength: 18
          maxLength: 18
          pattern: '^[A-Z][AEIOUX][A-Z]{2}[0-9]{2}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])[MH]([ABCMTZ]S|[BCJMOT]C|[CNPST]L|[GNQ]T|[GQS]R|C[MH]|[MY]N|[DH]G|NE|VZ|DF|SP)[BCDFGHJ-NP-TV-Z]{3}[0-9A-Z][0-9]$'
          description: CURP (loan/credit applicant MX Id).
          example: BADD110313HCMLNS09
        email:
          type: string
          minLength: 3
          maxLength: 80
          description: email
          pattern: '^(?:[a-z0-9!#$%&''*+/=?^_`{|}~]+(?:\.[a-z0-9!#$%&''*+/=?^_`{|}~]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$'
          example: api@circulodecredito.com.mx
          format: email

        processingModel:
          type: string
          description: '"ENRICHED|GATEWAY" (optional, defaults to "ENRICHED" if not specified)'
          enum:
            - GATEWAY
            - ENRICHED
          example: ENRICHED
        waitingTimeout:
          type: integer
          description: '[5, 10, 15, 30*, 60, 120, 180] minutes (optional, defaults to 30 if not specified with "ENRICHED")'
          enum:
            - 5
            - 10
            - 15
            - 30
            - 60
            - 120
            - 180
          example: 10
        enhancedAnalytics:
          type: boolean
          description: Indicates whether to include detailed historical job movement analytics in the response. When set to true, the response will provide comprehensive insights into an individual's employment history, including key statistics such as total days of employment, lifetime earnings, maximum base salary, and net income. Additionally, it will offer a breakdown of employment trends over time, highlighting changes in employment status and salary, as well as the number of distinct employers and the percentage of weeks with social security contributions.
          example: true
          
        extendedAnalytics:
          type: boolean
          description: Deliver key insights derived from a person's work history. By analyzing various aspects such as total working lifetime, job stability, details of the last job, unemployment trends, work continuity, and salary movements, it efficiently identifies valuable indicators that reveal meaningful patterns in the individual's career trajectory.
          example: true

        predictiveModels:
          type: boolean
          description: "When set to true, the API will calculate the Employment Verification Credit Score, providing insights into the applicant's creditworthiness based on their employment history."
        minimumRecencyDays:
          type: number
          description: "Accelerated Validity Verification: This feature enables immediate validation of data validity when the `minimumRecencyDays` parameter is included in the request. It verifies if the retrieved information remains valid for at least the specified number of days. If the validity period is shorter, the request will not be processed."


    SuccessEVConsumptionIMSSv3:
      type: object
      properties:
      
        acknowledgeId:
          type: string
          description: Acknowledge identifier (UUID).
          format: uuid
          example: b118d4d1-c52f-4caa-9e5c-b178464b97de
        dateTime:
          type: string
          description: Date and time of the acknowledge. As defined by date-time - RFC3339.
          format: date-time
          example: '2024-12-18T21:22:16.41Z'
        operation:
          type: string
          description: The operation performed.
          example: request
        message:
          type: string
          description: Descriptive and human-readable message.
          example: The employment verification request has been received.
        employmentVerification: 
        
          type: object
          properties:
            request:
              $ref: '#/components/schemas/EmploymentVerificationReqRespv3'
            names:
              type: string
              description: Concatenation of firstname and surname.
              example: VICENTE RAMON GUERRERO SALDAÑA
            birthday:
              type: string
              description: Birthday. As defined by full-date RFC3339.
              format: date
              example: '1986-03-11'
            workStatus:
              type: string
              description: Work status.
              enum:
                - W
                - NW
              example: W
            validUntil (optional):
              type: string
              format: date
              description: Date until the worker will have protection from, and contributions to, social security. If date is 3000-01-01 or null, the person is currently working. As defined by full-date RFC3339.
              example: '1829-04-01'
            workingHistory:
              type: object
              properties:
                date:
                  type: string
                  description: Date on which the working history report was created.
                  format: date
                  example: '2024-11-15'
                weeksContributed:
                  $ref: '#/components/schemas/WeeksContributed'
                workingHistoryDetail:
                  type: array
                  items:
                    type: object
                    properties:
                      employerName:
                        type: string
                        description: Employer's Name
                        example: CIRCULO DE CREDITO
                      employerRegister:
                        type: string
                        description: Employer registration number.
                        example: Y547329410
                      federalEntity:
                        type: string
                        description: Federal entity or state in which the work was executed.
                        example: CIUDAD DE MÉXICO
                      startDate:
                        type: string
                        description: Date on which the person started working with this employer.
                        format: date
                        example: '2023-03-06'
                      endDate:
                        type: string
                        description: Date on which the person stopped working with this employer. If still working, set to null.
                        format: date
                        example: null
                      lastContributionBaseSalary:
                        type: integer
                        description: Person's last salary subject of tax contribution. In currency.
                        example: 2714.25
                      workStatusEvents:
                        type: array
                        items:
                          $ref: '#/components/schemas/WorkStatusEvent'  
                      currency:
                        type: string
                        enum:
                          - 'MXN'
                        description: 'The actual currency for the given salary amounts.'
        
        predictiveModels:
          $ref: '#/components/schemas/respPredictiveModelsv3'
        enhancedAnalytics:
          $ref: '#/components/schemas/respEnhancedAnalyticsV1'  
        extendedAnalytics:
          $ref: '#/components/schemas/respExtendedAnalytics' 
          
        
        
        
      description: Information about a successful employment verification process.
    
    SuccessEVConsumptionIMSSPredictiveModels:
      $ref: '#/components/schemas/SuccessEVConsumptionIMSSv3'
      type: object
      properties:
        predictiveModels:
          $ref: '#/components/schemas/respPredictiveModelsv3'
        enhancedAnalytics:
          $ref: '#/components/schemas/respEnhancedAnalyticsV1'



    AckEmploymentVerification:
      type: object
      properties:
        acknowledgeId:
          maxLength: 36
          minLength: 36
          type: string
          description: Ackknowledge identifier (UUID).
          format: uuid
          readOnly: true
          example: 627aa72a-c799-4abf-b98e-0c4838af9bd5
        dateTime:
          type: string
          description: Date and time of the acknowledge. As defined by date-time - RFC3339.
          format: date-time
          readOnly: true
          example: '2020-04-12T22:20:50.52Z'
        operation:
          type: string
          description: Employment verification operation.
          readOnly: true
          example: request
          enum:
            - request
            - consumption
        message:
          maxLength: 120
          type: string
          description: Descriptive and human-readable message.
          readOnly: true
          example: The employment verification request has been received.
        employmentVerificationRequestId:
          maxLength: 36
          minLength: 36
          type: string
          description: employmentVerificationRequestId identifier (UUID).
          format: uuid
          readOnly: true
          example: 391d151f-1cac-44e7-a05b-79a1199621d6
        subscriptionId:
          maxLength: 36
          minLength: 36
          type: string
          description: subscriptionId identifier (UUID).
          format: uuid
          readOnly: true
          example: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
        inquiryId:
          maxLength: 36
          minLength: 36
          type: string
          description: subscriptionId identifier (UUID).
          format: uuid
          readOnly: true
          example: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c



    AckSuccessEVConsumptionIMSS:
      description: Acknowledge of a successful employment verification process IMSS.
      allOf:
        - $ref: '#/components/schemas/AckEmploymentVerification'

    AckFailureEVConsumption:
      description: Acknowledge of an unsuccessful employment verification process.
      type: object
      properties:
        acknowledgeId:
          type: string
          description: Acknowledge identifier (UUID).
          format: uuid
          example: b118d4d1-c52f-4caa-9e5c-b178464b97de
        dateTime:
          type: string
          description: Date and time of the acknowledge. As defined by date-time - RFC3339.
          format: date-time
          example: '2024-12-18T21:22:16.41Z'
        operation:
          type: string
          description: The operation performed.
          example: request
        message:
          type: string
          description: Descriptive and human-readable message.
          example: The employment verification request has been received.
        employmentVerification:
          type: object
          properties:
            errors:
              $ref: '#/components/schemas/Errors'
        
        
    Error:
      type: object
      properties:
        code:
          type: string
          description: Error code.
          example: '404'
        message:
          maxLength: 120
          type: string
          description: Descriptive and human-readable error message.
          example: The server understood the request but refuses to authorize it.
      description: Error
      
    Errors:
      type: object
      properties:
        errors:
          type: array
          maxItems: 10  # Added maximum number of items to fix the error
          description: List of errors.
          items:
            $ref: '#/components/schemas/Error'          
      description: A list of errors.
    Metadata:
      type: object
      properties:
        page:
          type: integer
          description: Current page.
          readOnly: true
          example: 7
        perPage:
          type: integer
          description: Rows per page.
          readOnly: true
          example: 15
        pageCount:
          type: integer
          description: Total number of pages.
          readOnly: true
          example: 12
        totalCount:
          type: integer
          description: Total number of rows.
          readOnly: true
          example: 175
        links:
          $ref: '#/components/schemas/Links'
      description: Pagination information.
    Links:
      type: object
      properties:
        self:
          type: string
          description: URL of this page.
          readOnly: true
          example: 'https://services.circulodecredito.com.mx/v1/eva/employmentverifications?page=7&perPage=15'
        first:
          type: string
          description: URL of the first page.
          readOnly: true
          example: 'https://services.circulodecredito.com.mx/v1/eva/employmentverifications?page=1&perPage=15'
        previous:
          type: string
          description: URL of the previous page.
          readOnly: true
          example: 'https://services.circulodecredito.com.mx/v1/eva/employmentverifications?page=6&perPage=15'
        next:
          type: string
          description: URL of the next page.
          readOnly: true
          example: 'https://services.circulodecredito.com.mx/v1/eva/employmentverifications?page=8&perPage=15'
        last:
          type: string
          description: URL of the last page.
          readOnly: true
          example: 'https://services.circulodecredito.com.mx/v1/eva/employmentverifications?page=12&perPage=15'
      description: Pagination information.
      
    WeeksContributed:
      type: object
      properties:
        totalContributedWeeks:
          type: integer
          description: Number of weeks contributed to the IMSS (semanas cotizadas IMSS)
        discountedWeeks:
          type: integer
          description: discounted weeks  (Semanas Descontadas)
        reinstatedWeeks:
          type: integer
          description: reinstated weeks (Semanas Reintegradas)
      description: Weeks contributed details
    WorkStatusEvent:
      type: object
      properties:
        changeType:
          type: integer
          description: Sometimes this field can be appear empty due platform switches on IMSS. This field represent the description of the change in the person's work status (2 = Baja 7 = Modificación de Salario 8 = Reingreso 9 = Aportación Voluntaria 11 = Ausentismo 12 = Incapacidad)
          enum:
            - 2
            - 7
            - 8
            - 9
            - 11
            - 12
        eventDate:
          type: string
          description: Date on which the change takes effect
          format: date
        baseSalary:
          type: string
          description: Base salary set after the change in the work status. In Cents
          example: '10045'
    
    
    WorkingHistoryDetail:
      type: object
      properties:
        employerName:
          type: string
          description: Employer's Name
          example: Name
        employerRegister:
          type: string
          description: 'Number or password assigned by the IMSS, to a employer, when it was registered in the institute (registro del patron)'
          example: '1234567'
        federalEntity:
          type: string
          description: 'Federal entity or state in which the work was executed '
          example: CDMX
        startDate:
          type: string
          description: Date on which the person started working with this employer. Format yyyy-mm-dd
          format: date
        endDate:
          type: string
          description: 'Date on which the person stop working with this employer. Format yyyy-mm-dd. If the person is still working "Vigente", set it to null'
          format: date
        lastContributionBaseSalary:
          type: integer
          description: Person's last salary subject of tax contribution. In cents
        workStatusEvents:
          type: array
          items:
            $ref: '#/components/schemas/WorkStatusEvent'
        
    WorkingHistory:
      type: object
      properties:
        date:
          type: string
          description: Date on which the Work History report was created (From IMSS). Format yyyy-mm-dd
          format: date
        weeksContributed:
          $ref: '#/components/schemas/WeeksContributed'
        workingHistoryDetail:
          type: array
          description: Detail of the user's working history
          items:
            $ref: '#/components/schemas/WorkingHistoryDetail'
      description: Detail of the user's working history**Available when mode = 2**
    Gender:
      title: Gender
      description: Gender with which the person registered.
      example: MUJER
      type: string
      enum:
        - MUJER
        - HOMBRE
    CivilState:
      title: CivilState
      description: Civil state
      example: CASADO (A)
      type: string
      enum:
        - CASADO (A)
        - SOLTERO (A)
        - VIUDO (A)
        - DIVORCIADO (A)
    AccessMedicalService:
      title: AccessMedicalService
      description: Work status.
      type: string
      enum:
        - 'Y'
        - 'N'
    TypeBeneficiary:
      title: TypeBeneficiary
      example: TRABAJADOR
      type: string
      enum:
        - TRABAJADOR
        - PENSIONISTA
    AffiliationStatus:
      title: AffiliationStatus
      example: INACTIVO
      type: string
      enum:
        - ACTIVO
        - INACTIVO
    Pensiontype:
      title: Pensiontype
      description: Type of pension.
      example: BASE
      type: string
      enum:
        - BASE
        - LISTA DE RAYA
    LaborDataDetail:
      title: LaborDataDetail
      type: object
      properties:
        branch:
          description: Dependency Branch.
          example: COMISION NACIONAL DEL AGUA (CONAGUA)
          type: string
        payment:
          description: Dependency Payment.
          example: (CONAGUA)
          type: string
        pensiontype:
          type: object
          allOf:
            - $ref: '#/components/schemas/Pensiontype'
            - description: Type of pension.
              example: BASE
        startDate:
          description: Date of discharge in the Dependency. Format yyyy-mm-dd
          type: string
          format: date
        quotedBaseSalary:
          description: Person's last salary subject of tax contribution. In cents
          type: integer
          format: int32
        totalRemuneration:
          description: Person's last salary subject of tax contribution. In cents
          type: integer
          format: int32
        modality:
          description: Service modality
          type: string
    AddressDetail:
      title: AddressDetail
      type: object
      properties:
        street:
          description: Address street.
          example: PRIVADA DE ITALIA
          type: string
        outdoorNumber:
          description: Outdoor number of Address.
          example: '20'
          type: string
        interiorNumber:
          description: Interior number of Address.
          type: string
        settlement:
          description: Settlement.
          example: LA LUZ
          type: string
        delegationMunicipality:
          description: Delegation or municipality of Address.
          example: CUAUTITLAN IZCALLI
          type: string
        state:
          description: State of Address.
          example: MEXICO
          type: string
        postalCode:
          description: Postal Code of Address.
          example: '54716'
          type: string


    AckSuccessEVConsumptionPretictiveModels:
      description: Result with predictive models
      title: Consumtion Result with predcitve models
      type: object
      properties:
        feature:
          type: number
          example: 0.5
    respLoanAmmountResult:
      title: loanAmmountResult
      type: object
      properties:
        range:
          type: integer
          example: 1
        minimunAmmount:
          type: integer
          example: 1
        maximunAmmount:
          type: integer
          example: 39
        defaultScore:
          type: integer
          example: 1595
    respCreditScoreFeaturesFeature:
      title: respCreditScoreFeature
      type: object
      properties:
        feature:
          type: number
          example: 0.5
    respEVCreditScore:
      title: respEVCreditScore
      type: object
      required:
        - result
      properties:
        result:
          type: integer
          example: 550
        reasonCodes:
          type: string
          readOnly: true
          example: D8
          enum:
            - E1
            - E2
            - E3
        features:
          type: array
          items:
            $ref: '#/components/schemas/respCreditScoreFeaturesFeature'

    respEVCreditScoreFeaturesFeature:
      title: respEVCreditScoreFeature
      type: object
      properties:
        feature:
          type: number
          example: 0.5
    
    respEmploymentStabilityIndexFeaturesFeature:
      title: respEmploymentStabilityIndexFeaturesFeature
      type: object
      properties:
        feature:
          type: number
          example: 0.5
    
    respEmploymentStabilityIndexv3:
      title: respEmploymentStabilityIndex
      type: object
      required:
        - result
      properties:
        result:
          type: string
          example: nivel_1
    
    respEmploymentStabilityIndex:
      title: respEmploymentStabilityIndex
      type: object
      required:
        - result
      properties:
        result:
          type: string
          example: nivel_1
        features:
          type: array
          items:
            $ref: '#/components/schemas/respEmploymentStabilityIndexFeaturesFeature'
    respPredictiveModels:
      title: respPredictiveModels
      type: object
      properties:
        employmentStabilityIndex:
          $ref: '#/components/schemas/respEmploymentStabilityIndex'
        EVCreditScore:
          $ref: '#/components/schemas/respEVCreditScore'
    
    respPredictiveModelsv3:
      title: respPredictiveModels
      type: object
      properties:
        employmentStabilityIndex:
          $ref: '#/components/schemas/respEmploymentStabilityIndexv3'
        EVCreditScore:
          $ref: '#/components/schemas/respEVCreditScorev3'
          
    respEVCreditScorev3:
      title: respEVCreditScore
      type: object
      required:
        - result
      properties:
        result:
          type: integer
          example: 550
    
    respEnhancedAnalyticsV1:
      type: object
      properties:
        type1:
          type: object
          properties:
            diasDeContratacion:
              type: object
              properties:
                cDiasDeContratacion:
                  type: integer
                diasDeContratacionMax:
                  type: integer
                diasDeContratacionMean:
                  type: number
                diasDeContratacionMedian:
                  type: number
                diasDeContratacionMin:
                  type: integer
                diasDeContratacionStd:
                  type: number
            lifetimeEarnings:
              type: number
            maxBaseSalary:
              type: object
              properties:
                cMaxBaseSalary:
                  type: integer
                maxBaseSalaryMax:
                  type: number
                maxBaseSalaryMean:
                  type: number
                maxBaseSalaryMedian:
                  type: number
                maxBaseSalaryMin:
                  type: number
                maxBaseSalaryStd:
                  type: number
            netIncome:
              type: object
              properties:
                cNetIncome:
                  type: integer
                netIncomeMax:
                  type: number
                netIncomeMean:
                  type: number
                netIncomeMedian:
                  type: number
                netIncomeMin:
                  type: number
                netIncomeStd:
                  type: number
            netIncomeHistorico:
              type: array
              items:
                type: object
                properties:
                  duration:
                    type: integer
                  employmentStatus:
                    type: string
                  endDate:
                    type: string
                    format: date
                  event:
                    type: integer
                  netIncome:
                    type: number
                  startDate:
                    type: string
                    format: date
            pctIncrementoBaseSalary:
              type: object
              properties:
                cPctIncrementoBaseSalary:
                  type: integer
                pctIncrementoBaseSalaryMax:
                  type: number
                pctIncrementoBaseSalaryMean:
                  type: number
                pctIncrementoBaseSalaryMedian:
                  type: number
                pctIncrementoBaseSalaryMin:
                  type: number
                pctIncrementoBaseSalaryStd:
                  type: number
        type2:
          type: object
          properties:
            diasDeContratacion:
              type: integer
            nbDistinctEmployers:
              type: integer
            pctSemanasCotizadas:
              type: number
            pctSemanasDescontadas:
              type: number
            totalSalaryDecreases:
              type: number
            totalSemanas:
              type: integer
              
    respExtendedAnalytics:
      type: object
      properties:
        jobStability:
          $ref: '#/components/schemas/JobStability'
        lastJob:
          $ref: '#/components/schemas/LastJob'
        person:
          $ref: '#/components/schemas/Person'
        unemployment:
          $ref: '#/components/schemas/Unemployment'
        wage:
          $ref: '#/components/schemas/Wage'
        workingContinuity:
          $ref: '#/components/schemas/WorkingContinuity'
        workingLifetime:
          $ref: '#/components/schemas/WorkingLifetime'

    JobStability:
      type: object
      properties:
        PersonAverageNewJobsPerYearCount:
          type: number
          example: 1
          description: "Annual average of registered employments (including changes within the same employer)."
        PersonAverageUniqueEmployersPerYearCount:
          type: number
          example: 1
          description: "Annual average of unique employers."
        PersonMaximumNewJobsPerYearCount:
          type: number
          example: 3
          description: "Maximum number of registered employments in a single year (including changes within the same employer)."
        PersonMaximumUniqueEmployersPerYearCount:
          type: number
          example: 2
          description: "Maximum number of unique employers in a single year."
        PersonTotalNewJobsCount:
          type: number
          example: 5
          description: "Total number of registered employments (including multiple jobs with the same employer)."
        PersonTotalUniqueEmployeersCount:
          type: number
          example: 5
          description: "Total number of unique employers."
        PersonWorkingLifetimeRatioPercentage:
          type: number
          example: 1.06
          description: "Ratio between years worked (starting from age 18) and the total number of years since the first employment record."
        WorkHistorAverageDurationMonths:
          type: number
          example: 31.76
          description: "Average duration in months of each employment period."
        WorkHistoryMaximumDurationMonths:
          type: number
          example: 95.37
          description: "Longest duration in months of a single employment period."
        WorkHistoryMinimumDurationMonths:
          type: number
          example: 0.63
          description: "Shortest duration in months of a single employment period."
        WorkHistoryTotalDurationMonths:
          type: number
          example: 158.8
          description: "Total number of months worked across all employment periods."

    LastJob:
      type: object
      properties:
        LastJobAverageRatioPercentage:
          type: number
          example: 61.08
          description: "Ratio of total days worked in the last job to the average days worked."
        LastJobDurationDays:
          type: number
          example: 582
          description: "Number of days worked in the last job."
        LastJobDurationMonths:
          type: number
          example: 19.4
          description: "Number of months worked in the last job."
        LastJobEndDateDate:
          type: string
          format: date
          example: "1900-01-01"
          description: "End date of the last job."
        LastJobMaximumRatioPercentage:
          type: number
          example: 20.34
          description: "Ratio of total days worked in the last job to the maximum days worked."
        LastJobStartAgeDecile:
          type: string
          example: "90 - 100"
          description: |
            Age at the start of the last job classified into decile ranges.
    
            Ranges:
            - 0-10: [16, 22]
            - 10-20: (22, 24]
            - 20-30: (24, 26]
            - 30-40: (26, 28]
            - 40-50: (28, 30]
            - 50-60: (30, 33]
            - 60-70: (33, 37]
            - 70-80: (37, 42]
            - 80-90: (42, 50]
            - 90-100: (50, 80]
        LastJobStartAgeYears:
          type: number
          example: 52
          description: "Age at the start of the last job."
        LastJobStartDateDate:
          type: string
          format: date
          example: "2023-07-31"
          description: "Start date of the last job."
        LastJobTotalRatioPercentage:
          type: number
          example: 4.68
          description: "Ratio of total days worked in the last job to total days worked."
        LastJobWorkHistoryRatioPercentage:
          type: number
          example: 12.22
          description: "Ratio of total days worked in the last job to the average days worked."

    Person:
      type: object
      properties:
        PersonAgeDecile:
          type: string
          example: "80 - 90"
          description: "Age at the time of inquiry, classified into decile ranges"
        PersonAgeYears:
          type: number
          example: 54
          description: "Age at the time of inquiry"
        PersonWorkingStatusFlag:
          type: integer
          example: 1

    Unemployment:
      type: object
      properties:
        LastUnemploymentAverageRatioPercentage:
          type: number
          example: 251.61
          description: "Ratio of days in the last unemployment period to the average days of unemployment."
        LastUnemploymentDurationDays:
          type: number
          example: 4836
          description: "Duration in days of the last unemployment period."
        LastUnemploymentDurationMonths:
          type: number
          example: 161.2
          description: "Duration in months of the last unemployment period."
        LastUnemploymentMaximumRatioPercentage:
          type: number
          example: 100.0
          description: "Ratio of days in the last unemployment period to the maximum days of unemployment."
        LastUnemploymentStartDateDate:
          type: string
          format: date
          example: "2010-05-04"
          description: "Start date of the last unemployment period."
        LastUnemploymentTotalRatioPercentage:
          type: number
          example: 38.88
          description: "Ratio of days in the last unemployment period to the total days elapsed since the first employment record to the query date."
        LastUnemploymentWorkHistoryRatioPercentage:
          type: number
          example: 62.9
          description: "Ratio of days in the last unemployment period to the total days of unemployment."
        PersonAverageUnemploymentPeriodMonths:
          type: number
          example: 64.07
          description: "Average number of months of unemployment."
        PersonMaximumUnemploymentPeriodMonths:
          type: number
          example: 161.2
          description: "Maximum number of months of unemployment."
        PersonMinimumUnemploymentPeriodMonths:
          type: number
          example: 0.0
          description: "Minimum number of months of unemployment."
        PersonTotalUnemploymentDecile:
          type: string
          example: "90 - 100"
          description: |
            Total months of unemployment classified into decile ranges.
    
            Ranges:
            - 0-10: [0, 0.1]
            - 10-20: (0.1, 3.3]
            - 20-30: (3.3, 8.67]
            - 30-40: (8.67, 18.37]
            - 40-50: (18.37, 29.93]
            - 50-60: (29.93, 44.23]
            - 60-70: (44.23, 65.6]
            - 70-80: (65.6, 94.67]
            - 80-90: (94.67, 154.77]
            - 90-100: (154.77, 541.7]
        PersonTotalUnemploymentMonths:
          type: number
          example: 256.27
          description: "Total number of months of unemployment."

    Wage:
      type: object
      properties:
        LastJobDailyWageAmount:
          type: number
          example: 293.11
          description: "Daily wage of the last job."
        LastJobMonthlyWageAmount:
          type: number
          example: 8793.3
          description: "Monthly wage of the last job."
        PersonAverageDailyNetIncomeAmount:
          type: number
          example: 200.42
          description: "Average base daily wage."
        PersonLast3YearsDailyAverageNetIncomeAmount:
          type: number
          example: 258.39
          description: "Average base daily wage in the last 3 years."
        PersonLast3YearsDailyMaximumNetIncomeAmount:
          type: number
          example: 293.11
          description: "Maximum base daily wage in the last 3 years."
        PersonLast3YearsMinimumNetIncomeAmount:
          type: number
          example: 217.85
          description: "Minimum base daily wage in the last 3 years."
        PersonLast3YearsTotalNetIncomeAmount:
          type: number
          example: 147385.72
          description: "Total income in the last 3 years."
        PersonLast5YearsDailyAverageNetIncomeAmount:
          type: number
          example: 258.39
          description: "Average base daily wage in the last 5 years."
        PersonLast5YearsDailyMaximumNetIncomeAmount:
          type: number
          example: 293.11
          description: "Maximum base daily wage in the last 5 years."
        PersonLast5YearsMinimumNetIncomeAmount:
          type: number
          example: 217.85
          description: "Minimum base daily wage in the last 5 years."
        PersonLast5YearsTotalNetIncomeAmount:
          type: number
          example: 147385.72
          description: "Total income in the last 5 years."
        PersonLastYearDailyAverageNetIncomeAmount:
          type: number
          example: 277.25
          description: "Average base daily wage in the last year."
        PersonLastYearDailyMaximumNetIncomeAmount:
          type: number
          example: 293.11
          description: "Maximum base daily wage in the last year."
        PersonLastYearMinimumNetIncomeAmount:
          type: number
          example: 261.38
          description: "Minimum base daily wage in the last year."
        PersonLastYearTotalNetIncomeAmount:
          type: number
          example: 97370.96
          description: "Total income in the last year."
        PersonMaximumDailyNetIncomeAmount:
          type: number
          example: 327.91
          description: "Maximum base daily wage."
        PersonMinimumDailyNetIncomeAmount:
          type: number
          example: 10.36
          description: "Minimum base daily wage."
        PersonTotalNetIncomeAmount:
          type: number
          example: 1001983.94
          description: "Total income."
        WageChangeFirstLastPercentage:
          type: number
          example: 2729.25
          description: "Percentage change between the first and the last wage recorded."
        WorkHistoryAverageWageIncrementPercentage:
          type: number
          example: 19.2
          description: "Average percentage change in base wage."
        WorkHistoryMaximumWageIncrementPercentage:
          type: number
          example: 376.06
          description: "Maximum percentage change in base wage."
        WorkHistoryMinimumWageIncrementPercentage:
          type: number
          example: 0.07
          description: "Minimum percentage change in base wage."

    WorkingContinuity:
      type: object
      properties:
        LastContinuousContributionPeriodAverageRatioPercentage:
          type: number
          example: 61.08
          description: "Ratio of days in the last continuous work period to the average days worked."
        LastContinuousContributionPeriodDurationDays:
          type: number
          example: 582
          description: "Duration in days of the last continuous work period (without inactivity longer than 30 days)."
        LastContinuousContributionPeriodDurationDecile:
          type: string
          example: "20 - 30"
          description: |
            Months of the last continuous work period classified into decile ranges.
    
            Ranges:
            - 0-10: [0.03, 1.77]
            - 10-20: (1.77, 4.47]
            - 20-30: (4.47, 7.53]
            - 30-40: (7.53, 13.53]
            - 40-50: (13.53, 21.17]
            - 50-60: (21.17, 31.27]
            - 60-70: (31.27, 52.47]
            - 70-80: (52.47, 84.13]
            - 80-90: (84.13, 148]
            - 90-100: (148, 793.03]
        LastContinuousContributionPeriodDurationMonths:
          type: number
          example: 19.4
          description: "Duration in months of the last continuous work period."
        LastContinuousContributionPeriodDurationWeeks:
          type: number
          example: 83.14
          description: "Duration in weeks of the last continuous work period."
        LastContinuousContributionPeriodDurationYears:
          type: number
          example: 1.59
          description: "Duration in years of the last continuous work period."
        LastContinuousContributionPeriodHistoryRatioPercentage:
          type: number
          example: 12.22
          description: "Ratio of days in the last continuous work period to the total days worked."
        LastContinuousContributionPeriodMaximumRatioPercentage:
          type: number
          example: 20.34
          description: "Ratio of days in the last continuous work period to the maximum days worked."
        LastContinuousContributionPeriodStartDateDate:
          type: string
          format: date
          example: "2023-07-31"
          description: "Start date of the last continuous work period."
        LastContinuousContributionPeriodTotalRatioPercentage:
          type: number
          example: 4.68
          description: "Ratio of days in the last continuous work period to the total days elapsed since the first employment record to the query date."

    WorkingLifetime:
      type: object
      properties:
        PersonAdultWorkingLifetimeYears:
          type: number
          example: 36.08
          description: "Elapsed years of work since the individual turned 18."
        PersonAverageMonthsWithMultipleJobsCount:
          type: number
          example: 0.5
          description: "Average number of months with simultaneous jobs."
        PersonMaximumMonthsWithMultipleJobsCount:
          type: number
          example: 0.5
          description: "Maximum number of months with simultaneous jobs."
        PersonMaximumMultipleJobsCount:
          type: number
          example: 1
          description: "Maximum number of simultaneous jobs held at the same time."
        PersonTotalMonthsWithMultipleJobsCount:
          type: number
          example: 0.5
          description: "Total number of months with simultaneous jobs."
        PersonWorkingAgeYears:
          type: number
          example: 34.07
          description: "Elapsed years (worked and non-worked) since the first employment record."
        PersonWorkingLifetimeDays:
          type: number
          example: 12437
          description: "Elapsed days (worked and non-worked) since the first employment record."
        PersonWorkingLifetimeDecile:
          type: string
          example: "90 - 100"
          description: "Total number of years since the first employment record, classified into decile ranges."
        PersonWorkingLifetimeMonths:
          type: number
          example: 414.57
          description: "Elapsed months (worked and non-worked) since the first employment record."
        PersonWorkingLifetimeWeeks:
          type: number
          example: 1776.71
          description: "Elapsed weeks (worked and non-worked) since the first employment record."
        PersonWorkingStartAgeQuartile:
          type: string
          example: "0 - 25"
          description: "Age at the time of the first employment record, classified into quartile ranges."
        PersonWorkingStartAgeYears:
          type: number
          example: 20
          description: "Age at the time of the first employment record."
        PersonWorkingStartDateDate:
          type: string
          format: date
          example: "1991-02-14"
          description: "First recorded employment start date."
        WorkingHistoryAvgDays:
          type: number
          example: 952.8
          description: "Average number of days worked per employment period."
        WorkingHistoryMaxDays:
          type: number
          example: 2861
          description: "Maximum number of days worked in a single employment period."
        WorkingHistoryMinDays:
          type: number
          example: 19
          description: "Minimum number of days worked in a single employment period."
        WorkingHistoryTotalDays:
          type: number
          example: 4764
          description: "Total number of days worked across all employment periods."
              
    fullSuccessEVConsumptionV1:
      type: object
      properties:
        acknowledgeId:
          type: string
          description: Acknowledge identifier (UUID).
          format: uuid
          example: b118d4d1-c52f-4caa-9e5c-b178464b97de
        dateTime:
          type: string
          description: Date and time of the acknowledge. As defined by date-time - RFC3339.
          format: date-time
          example: '2024-12-18T21:22:16.41Z'
        operation:
          type: string
          description: The operation performed.
          example: request
        message:
          type: string
          description: Descriptive and human-readable message.
          example: The employment verification request has been received.
        employmentVerification:
          type: object
          properties:
            request:
              $ref: '#/components/schemas/EmploymentVerificationReqResp'
            names:
              type: string
              description: Concatenation of firstname and surname.
              example: VICENTE RAMON GUERRERO SALDAÑA
            birthday:
              type: string
              description: Birthday. As defined by full-date RFC3339.
              format: date
              example: '1986-03-11'
            workStatus:
              type: string
              description: Work status.
              enum:
                - W
                - NW
              example: W
            validUntil (optional):
              type: string
              format: date
              description: Date until the worker will have protection from, and contributions to, social security. If date is 3000-01-01 or null, the person is currently working. As defined by full-date RFC3339.
              example: '1829-04-01'
            nssCheck:
              type: boolean
              description: Indicates if the NSS check was performed.
              example: false
            workingHistory:
              type: object
              properties:
                date:
                  type: string
                  description: Date on which the working history report was created.
                  format: date
                  example: '2024-11-15'
                weeksContributed:
                  $ref: '#/components/schemas/WeeksContributed'
                workingHistoryDetail:
                  type: array
                  items:
                    type: object
                    properties:
                      employerName:
                        type: string
                        description: Employer's Name
                        example: CIRCULO DE CREDITO
                      employerRegister:
                        type: string
                        description: Employer registration number.
                        example: Y547329410
                      federalEntity:
                        type: string
                        description: Federal entity or state in which the work was executed.
                        example: CIUDAD DE MÉXICO
                      startDate:
                        type: string
                        description: Date on which the person started working with this employer.
                        format: date
                        example: '2023-03-06'
                      endDate:
                        type: string
                        description: Date on which the person stopped working with this employer. If still working, set to null.
                        format: date
                        example: null
                      lastContributionBaseSalary:
                        type: number
                        description: Person's last salary subject of tax contribution. In currency.
                        example: 2714.25
                      workStatusEvents:
                        type: array
                        items:
                          $ref: '#/components/schemas/WorkStatusEvent'
        employmentStabilityIndex:
              type: string
              example: nivel_1
              enum:
                - nivel_1
                - nivel_2
                - nivel_3
        enhancedAnalytics:
              type: object
              properties:
                type1:
                  type: object
                  properties:
                    diasDeContratacion:
                      type: object
                      properties:
                        cDiasDeContratacion:
                          type: integer
                          example: 9
                        diasDeContratacionMax:
                          type: integer
                          example: 1541
                        diasDeContratacionMean:
                          type: number
                          example: 542.67
                        diasDeContratacionMedian:
                          type: integer
                          example: 395
                        diasDeContratacionMin:
                          type: integer
                          example: 6
                        diasDeContratacionStd:
                          type: number
                          example: 489.31
                    lifetimeEarnings:
                      type: number
                      example: 5479039.76
                    maxBaseSalary:
                      type: object
                      properties:
                        cMaxBaseSalary:
                          type: integer
                          example: 9
                        maxBaseSalaryMax:
                          type: number
                          example: 2714.25
                        maxBaseSalaryMean:
                          type: number
                          example: 627.23
                        maxBaseSalaryMedian:
                          type: number
                          example: 89.89
                        maxBaseSalaryMin:
                          type: number
                          example: 66.79
                        maxBaseSalaryStd:
                          type: number
                          example: 995.64
                    netIncome:
                      type: object
                      properties:
                        cNetIncome:
                          type: integer
                          example: 12
                        netIncomeMax:
                          type: number
                          example: 2714.25
                        netIncomeMean:
                          type: number
                          example: 455.44
                        netIncomeMedian:
                          type: number
                          example: 77.81
                        netIncomeMin:
                          type: number
                          example: 0
                        netIncomeStd:
                          type: number
                          example: 910.91
                    netIncomeHistorico:
                      type: array
                      items:
                        type: object
                        properties:
                          duration:
                            type: integer
                            example: 653
                          employmentStatus:
                            type: string
                            example: employed
                          endDate:
                            type: string
                            format: date
                            example: '2024-12-18'
                          event:
                            type: integer
                            example: 12
                          netIncome:
                            type: number
                            example: 2714.25
                          startDate:
                            type: string
                            format: date
                            example: '2023-03-06'
                    pctIncrementoBaseSalary:
                      type: object
                      properties:
                        cPctIncrementoBaseSalary:
                          type: integer
                          example: 8
                        pctIncrementoBaseSalaryMax:
                          type: number
                          example: 97.13
                        pctIncrementoBaseSalaryMean:
                          type: number
                          example: -11.32
                        pctIncrementoBaseSalaryMedian:
                          type: number
                          example: -8.73
                        pctIncrementoBaseSalaryMin:
                          type: number
                          example: -96.03
                        pctIncrementoBaseSalaryStd:
                          type: number
                          example: 51.22
                type2:
                  type: object
                  properties:
                    diasDeContratacion:
                      type: integer
                      example: 653
                    nbDistinctEmployers:
                      type: integer
                      example: 8
                    pctSemanasCotizadas:
                      type: number
                      example: 100
                    pctSemanasDescontadas:
                      type: number
                      example: 0
                    totalSalaryDecreases:
                      type: integer
                      example: 2
                    totalSemanas:
                      type: integer
                      example: 694
                    
    EmploymentVerificationReqResp:
      title: EmploymentVerification
      description: Employment verification information
      required:
        - employmentVerificationRequestId
        - subscriptionId
        - curp
        - email
        - dataProvider
      properties:
        employmentVerificationRequestId:
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: The identifier of the employment verification request given by the
            API consumer (UUID).
          format: uuid
          example: 391d151f-1cac-44e7-a05b-79a1199621d6
        subscriptionId:
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: The API Hub event subscription identifier (UUID).
          format: uuid
          example: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
        inquiryId:
          maxLength: 36
          minLength: 36
          type: string
          description: The employment verification process identifier given by Círculo de
            Crédito.
          format: uuid
          readOnly: true
          example: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
        successCheck:
          description: It is true if the employment verification process ended successfully.
          example: true
          readOnly: true
          type: boolean
        inquiryStatus:
          type: string
          description: Inquiry status.
          enum:
            - RI
            - SN
            - DN
            - DND
            - CI
          example: DN
          readOnly: true
        curp:
          description: CURP (loan/credit applicant MX Id).
          example: BADD110313HCMLNS09
          type: string
          minLength: 18
          maxLength: 18
        email:
          description: email
          example: api@circulodecredito.com.mx
          type: string
          minLength: 3
          maxLength: 80
        processingModel:
          type: string
          description: '"ENRICHED|GATEWAY" (optional, defaults to "ENRICHED" if not specified)'
          enum:
            - GATEWAY
            - ENRICHED
          example: ENRICHED
        waitingTimeout:
          type: integer
          description: '[5, 10, 15, 30*, 60, 120, 180] minutes (optional, defaults to 30 if not specified with "ENRICHED")'
          enum:
            - 5
            - 10
            - 15
            - 30
            - 60
            - 120
            - 180
          example: 10
        enhancedAnalytics:
          type: boolean
          description: Indicates whether to include detailed historical job movement analytics in the response. When set to true, the response will provide comprehensive insights into an individual's employment history, including key statistics such as total days of employment, lifetime earnings, maximum base salary, and net income. Additionally, it will offer a breakdown of employment trends over time, highlighting changes in employment status and salary, as well as the number of distinct employers and the percentage of weeks with social security contributions.
          example: true
        extractionType: 
          type: string
          enum:
            - Internal Data Source
            - External Data Source
          example: "Internal Data Source"
        dataExtractionDate:
          type: string
          description: Date and time of the acknowledge. As defined by date-time - RFC3339.
          format: date-time
          readOnly: true
          example: '2020-04-12T22:20:50.52Z'

    EmploymentVerificationReqRespv3:
      title: EmploymentVerification
      description: Employment verification information
      required:
        - employmentVerificationRequestId
        - subscriptionId
        - curp
        - email
        - dataProvider
      properties:
        employmentVerificationRequestId:
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: The identifier of the employment verification request given by the
            API consumer (UUID).
          format: uuid
          example: 391d151f-1cac-44e7-a05b-79a1199621d6
        subscriptionId:
          type: string
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          description: The API Hub event subscription identifier (UUID).
          format: uuid
          example: 7c8a0230-36e0-43f4-9b7a-581dc55ea9c3
        inquiryId:
          maxLength: 36
          minLength: 36
          type: string
          description: The employment verification process identifier given by Círculo de
            Crédito.
          format: uuid
          readOnly: true
          example: a19fb6b8-2677-44f2-9cd7-3b2f78bb6f8c
        successCheck:
          description: It is true if the employment verification process ended successfully.
          example: true
          readOnly: true
          type: boolean
        inquiryStatus:
          type: string
          description: Inquiry status.
          enum:
            - RI
            - SN
            - DN
            - DND
            - CI
          example: DN
          readOnly: true
        curp:
          description: CURP (loan/credit applicant MX Id).
          example: BADD110313HCMLNS09
          type: string
          minLength: 18
          maxLength: 18
        email:
          description: email
          example: api@circulodecredito.com.mx
          type: string
          minLength: 3
          maxLength: 80
        enhancedAnalytics:
          type: boolean
          description: Indicates whether to include detailed historical job movement analytics in the response. When set to true, the response will provide comprehensive insights into an individual's employment history, including key statistics such as total days of employment, lifetime earnings, maximum base salary, and net income. Additionally, it will offer a breakdown of employment trends over time, highlighting changes in employment status and salary, as well as the number of distinct employers and the percentage of weeks with social security contributions.
          example: true
        extractionType: 
          type: string
          enum:
            - Internal Data Source
            - External Data Source
          example: "Internal Data Source"
        minimumRecencyDays:
          type: number
          description: 'desc'
          readOnly: true
          example: 60
        dataExtractionDate:
          type: string
          description: Date and time of the acknowledge. As defined by date-time - RFC3339.
          format: date-time
          readOnly: true
          example: '2020-04-12T22:20:50.52Z'
        predictiveModels:
          type: boolean
          description: 'desc'
          readOnly: true
          example: true


  parameters:
    x-api-key:
      name: x-api-key
      in: header
      description: The Consumer Key assigned to the application you have registered in API Hub.
      required: true
      schema:
        type: string
    inquiryId:
      name: inquiryId
      in: path
      description: The identifier of the inquiry.
      required: true
      schema:
        type: string
    page:
      name: page
      in: query
      description: Page to query.
      schema:
        type: integer
    perPage:
      name: perPage
      in: query
      description: Rows per page.
      schema:
        type: integer
    startAt:
      name: startAt
      in: query
      description: Initial date. As defined by date-time - RFC3339.
      schema:
        type: string
        format: date-time
    endAt:
      name: endAt
      in: query
      description: End date.  As defined by date-time - RFC3339.
      schema:
        type: string
        format: date-time
    inquiryStatus:
      name: inquiryStatus
      in: query
      description: Inquiry status.
      schema:
        type: string
        enum:
          - RI
          - SN
          - DN
          - NDN
          - CI
    successCheck:
      name: successCheck
      in: query
      description: Inquiry process result.
      schema:
        type: boolean

  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
