openapi: 3.0.1
info:
  title: EVA Employment Verification API Sandbox v2.1.0
  description: |
    <div align="left">
      <img src='https://developer.circulodecredito.com.mx/sites/default/files/2024-01/Logo-Swaggers.png' height='60' width='240'/>
    </div>

    # **`Fast, Reliable Employment Verification for Mexico's Private and government Sector`**

    **Make informed lending decisions with EVA:**

    * ✅ **Instant Verification:** Confirm employment status in seconds.
    * ✅ **Risk Mitigation:** Identify potential risks associated with applicants.
    * ✅ **Data-Driven Insights:** Gain access to optional detailed employment data.
    * ✅ **Easy Integration:** Seamlessly integrate with your existing systems. 

    **🚀 Get started with EVA and make smarter lending decisions today!**

  termsOfService: https://developer.circulodecredito.com.mx/legal-mx
  contact:
    email: api@circulodecredito.com.mx
  version: 2.1.0
servers:
  - url: https://services.circulodecredito.com.mx/sandbox
tags:
  - name: EVA Employment Verification API (IMSS)
    externalDocs:
      description: API Hub
      url: https://developer.circulodecredito.com.mx/en/products/eva
paths:
  /v1/eva/employmentverifications/withPrivacyNotice:
    post:
      tags:
        - EVA Employment Verification API (IMSS)
      summary: Employment Verification Request (IMSS)
      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.
            * Allows you to set a custom `waitingTimeout` (in minutes) to define how long to wait for the external source before resorting to historical data. Choose from:
                * 5
                * 10
                * 15
                * 30 (default)
                * 60
                * 120
                * 180
        * **GATEWAY (Online):** Retrieves the latest real-time data from an external open data source. Specify this mode explicitly by setting `processingModel: "GATEWAY"`.

        **Additional Features:**

        * **Stability Index (Optional):** Get a quick assessment of an individual's job stability based on their employment history and industry trends.
        * **Enhanced Analytics (Optional):** Gain deeper insights with historical job movement data and detailed analysis. Include `"enhancedAnalytics": true` in your request to access this feature.

        **Understanding Responses (ENRICHED Mode):**

        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.

      operationId: employmentverificationsWithPrivacyNotice
      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: Signature created with your private key (SHA256withECDSA -
            secp384r). API Hub verifies the signature matches with the URL using
            your public key. Your public key must be uploaded in the API Hub
            Portal Applications section.
          required: true
          schema:
            type: string
      requestBody:
        description: Input parameters in order to start a employment verification process.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmploymentVerificationWithPrivacyNotice'
            examples:
              Traditional:
                summary: 'IMSS: Traditional'
                description: |
                  **A simple request to verify formal employment and assess industry risk.**

                  This streamlined request helps you quickly determine if a client or prospect is formally employed and evaluate the risk level associated with their industry. 

                  **Key Benefits:**

                  * **Swift Verification:**  Easily confirm employment status.
                  * **Risk Assessment:**  Gain insights into industry-specific risks.
                  * **Simplified Decision-Making:** Streamline your evaluation process with readily available information.
                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
              External-Data Source:
                summary: 'IMSS: External Data Source'
                description: |
                  This IMSS request prioritizes real-time data retrieval from external open data sources, ensuring you get the most up-to-date information.

                  **Key Features:**

                  * **`processingModel: GATEWAY`:**
                      * Exclusively focuses on fetching data online from the external open data source.
                      * Provides the most current and accurate information available.
                  * **Automatic Retries:**
                      * If the external source is temporarily unavailable, the request automatically enters a retry mechanism.
                      * This mechanism ensures updated employment data, attempting to fetch the data multiple times until it succeeds.

                  **Benefits:**

                  * **Real-Time Accuracy:** Get the latest data for sensitive updated-data employment decisions.
                  * **Reliability:**  Robust retry mechanism ensures data retrieval even with temporary outages.
                  * **Simplicity:** No need to configure additional parameters like `waitingTimeout`.

                  **Considerations:**

                  * **Response Time:** Validation might take over the average time when external data source is unavailable.

                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
              Internal-Data Source:
                summary: 'IMSS: Internal Data Source'
                description: |
                  This IMSS request allows you to control how data is retrieved, prioritizing either enriched internal data or real-time external sources.

                  **Key Features:**

                  * **`processingModel`:**  Determines the data retrieval strategy:
                      * `ENRICHED`: Prioritizes historical internal data if the external open data source is unavailable within the waitingTimeout.
                     
                  * **`waitingTimeout`:** (Optional, only with `processingModel: ENRICHED`)
                      * Specifies the maximum wait time (in minutes) for the external open data source to respond.
                      * Defaults to 30 minutes.
                      * If exceeded, historical internal data will be retrieved instead.

                  **Benefits:**

                  * **Flexibility:** Choose the best data source for your needs.
                  * **Reliability:**  Ensure you get results even with temporary external source issues.
                  * **Efficiency:** Optimize retrieval time based on your preferences.

                  **How to Use:**

                  1. Include the desired `processingModel` in your request.
                  2. If using `ENRICHED`, optionally specify `waitingTimeout` in minutes.

                  **Example:**
                  ```json
                  {
                    "processingModel": "ENRICHED",
                    "waitingTimeout": 45 
                  }
                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
                    waitingTimeout: 5
              Stability-Index:
                summary: 'IMSS: Employment Stability Index'
                description: |
                  Assess an individual's job stability with this insightful request.

                  **`What is the Employment Stability Index?`**

                  **The index gives you a clear picture of a person's job security, forecasting:**

                  * **If Employed:** The probability of staying in their current position over the next year.
                  * **If Unemployed:** The likelihood of securing a new job within the year.

                  **How It Works:**

                  The index utilizes a simple 3-level scale:

                  * **Level 1:** Highest stability for employed individuals, or highest chance of finding employment if unemployed.
                  * **Level 2:** Indicates moderate stability or job prospects.
                  * **Level 3:** Signals the lowest stability if employed, or lowest chance of re-employment for those unemployed.

                  **Why This Matters:**

                  Understanding job stability empowers you to:

                  * **Make Informed Decisions:** Identify potential career growth paths or risks.
                  * **Plan Ahead:** Prepare for potential shifts in your employment situation.
                  * **Understand the Market:** Gain valuable insights into broader job market trends.
                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:
                summary: 'IMSS: Enhanced Analytics'
                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
                    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}
        401:
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - code: "401.1"
                  message: Unauthorized, invalid x-api-key.
                - 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'
        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:
        - EVA Employment Verification API (IMSS)
      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:**

        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. |

      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: x-signature
        in: 'header'
        description: 'Signature created with your private key (SHA256withECDSA - secp384r). API Hub verifies the signature matches with the URL using your public key. Your public key must be uploaded in the API Hub Portal Applications section.'
        required: true
        schema:
          type: 'string'
      - name: inquiryId
        in: path
        description: The identifier of the inquiry.
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK - Returns the employment verification process information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckSuccessEVConsumptionIMSS'
              examples:
                Traditional:
                  summary: IMSS Traditional
                  description: 'An example of IMSS Request'
                  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: Name,
                              employerRegister: 1234567,
                              federalEntity: CDMX,
                              startDate: 2022-12-27,
                              endDate: 2022-12-27,
                              lastContributionBaseSalary: 0,
                              workStatusEvents: 
                                [
                                  {
                                    changeType: 2,
                                    eventDate: 2022-12-27,
                                    baseSalary: 10045
                                  }
                                ]
                            }
                          ]
                External-Data Source:
                  summary: IMSS External Data Source
                  description: 'An example of IMSS Request that operate online, waiting the necessary time for a updated response'
                  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:
                        extractionType: External Data Source
                        employmentVerificationRequestId: 391d151f-1cac-44e7-a05b-79a1199621d6
                        dataExtractionDate: 2020-04-12 22:20:50
                        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: Name,
                              employerRegister: 1234567,
                              federalEntity: CDMX,
                              startDate: 2022-12-27,
                              endDate: 2022-12-27,
                              lastContributionBaseSalary: 0,
                              workStatusEvents: 
                                [
                                  {
                                    changeType: 2,
                                    eventDate: 2022-12-27,
                                    baseSalary: 10045
                                  }
                                ]
                            }
                          ]
                Internal-Data Source:
                  summary: IMSS Internal Data Source
                  description: This example demonstrates an IMSS request that incorporates a
                    configurable waiting timeout. You can specify a
                    waitingTimeout property (optional, defaults to 30 minutes)
                    to define the maximum wait time in minutes. If the
                    verification process fails to receive an updated response
                    within this timeframe, the request will attempt to retrieve
                    historical data instead
                  value:
                    acknowledgeId: 627aa72a-c799-4abf-b98e-0c4838af9bd5
                    dateTime: 2023-04-12T22:20:50.52Z
                    operation: consumption
                    message: The employment verification request has been received.
                    employmentVerification:
                      request:
                        dataExtractionDate: 2023-04-12 22:20:50
                        extractionType: Internal Data Source
                        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: Name,
                              employerRegister: 1234567,
                              federalEntity: CDMX,
                              startDate: 2022-12-27,
                              endDate: 2022-12-27,
                              lastContributionBaseSalary: 0,
                              workStatusEvents: 
                                [
                                  {
                                    changeType: 2,
                                    eventDate: 2022-12-27,
                                    baseSalary: 10045
                                  }
                                ]
                            }
                          ]
                Employment-Stability-Index:
                    summary: IMSS Employment Stability Index
                    description: An example response of IMSS with EEmployment Stability Index 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.
                      employmentStabilityIndex: 'nivel_1'
                      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: Name
                              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:
                    summary: IMSS Enhanced Analytics
                    description: An example response of IMSS with 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
                        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"
                            # ... (other historical data entries omitted for brevity)
                            - 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
                          totalSemanas: 675
        400:
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - code: "400"
                  message: Missign parameters {x-api-key}.
        401:
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - code: "401.1"
                  message: Unauthorized, invalid x-api-key.
                - 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'
        404:
          description: Inquiry not found.
          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: "400"
                    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
                  request:
                    employmentVerificationRequestId: 23fa2ec7-3294-4aa4-ba65-a0f49a75bfc4
                    subscriptionId: 51752e30-eab2-4368-a4eb-ce5a34d90f04
                    inquiryId: a99c3501-7b3a-4b3e-8ca5-1e48225b8176
                    curp: PUPJ970229HDFZZG61
                    email: api61@circulodecredito.com.mx
                    inquiryStatus: DN
                    successCheck: false
        410:
          description: 'Gone -  The maximum time in order to obtain the payload has
            expired: 30 days.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - code: "410"
                  message: The maximum time in order to obtain the payload has expired.
        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"
                  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.
                  request:
                    employmentVerificationRequestId: d029a1ba-3566-4361-834a-f44add8cc4f7
                    subscriptionId: 51752e30-eab2-4368-a4eb-ce5a34d90f04
                    inquiryId: 43d21139-e1fa-4768-8b78-79aa3ca1993f
                    curp: PUPJ970229HDFZZG70
                    email: api70@circulodecredito.com.mx
                    inquiryStatus: RI
                    successCheck: false
        503:
          description: Service unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - code: "503"
                  message: Service unavailable.
  /v1/eva/employmentverifications/:
    get:
      tags:
      - EVA Employment Verification API (IMSS)
      summary: Returns the list of employment verification processes you have requested.
      description: Returns the list of employment verification processes you have
        requested. You could filter the rows by date using the <samp>{startAt}</samp>
        and <samp>{endAt}</samp> parameters. You could filter the rows by inquiry
        status using the <samp>{inquiryStatus}</samp> parameter and the process result
        using the <samp>{sucessCheck}</samp> parameter. The maximum number of returned
        rows is 20. You could use the <samp>{page}</samp> and <samp>{perPage}</samp>
        parameters in order to navigate through the list.
      operationId: getEmploymentVerifications
      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: page
        in: query
        description: Page to query.
        schema:
          type: integer
      - name: perPage
        in: query
        description: Rows per page.
        schema:
          type: integer
      - name: startAt
        in: query
        description: Initial date. As defined by date-time - RFC3339.
        schema:
          type: string
          format: date-time
      - name: endAt
        in: query
        description: End date.  As defined by date-time - RFC3339.
        schema:
          type: string
          format: date-time
      - name: inquiryStatus
        in: query
        description: Inquiry status.
        schema:
          type: string
          enum:
          - RI
          - SN
          - DN
          - NDN
          - CI
      - name: successCheck
        in: query
        description: Inquiry process result.
        schema:
          type: boolean
      responses:
        200:
          description: OK - Returns an employment verification processes list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmploymentVerificationMetadata'
        400:
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - code: "400"
                  message: Missign parameters {x-api-key}.
        401:
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - code: "401.1"
                  message: Unauthorized, invalid x-api-key.
                - 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: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - code: "404"
                  message: Page not found.
        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.

  /v2/eva/employmentverifications/withPrivacyNotice:
    post:
      summary: v2 Employment Verification Request (IMSS & ISSSTE)
      description: |
        Verify a person's employment status and retrieve relevant data with expanded coverage for both private and government sectors in Mexico.

        **Choose Your Data Provider:**

        * **IMSS:** 
            * Use `dataProvider: "IMS"` for employment verification of individuals working in Mexico's private sector. 
            * Offers flexible options through `processingModel` (ENRICHED or GATEWAY) and customizable `waitingTimeout` for prioritizing data sources and retrieval speed.

        * **ISSSTE:**
            * Use `dataProvider: "ISS"` for employment verification of individuals working in the Mexican government sector.

        **Additional Features (IMSS Only):**

        * **Stability Index:** Get a quick assessment of an individual's job stability based on their employment history and industry trends.
        * **Enhanced Analytics (Optional):** Gain deeper insights with historical job movement data and detailed analysis. Include `"enhancedAnalytics": true` in your request to access this feature.

        **Understanding Responses (IMSS ENRICHED Mode):**

        When using `ENRICHED` mode (default or with custom timeout) with the IMSS data provider, 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.

        **Example Requests:**

        * **IMSS (GATEWAY Mode):**

          ```json
          {
            "dataProvider": "IMS",
            "processingModel": "GATEWAY"
          }
          ```

        * **ISSSTE:**

          ```json
          {
            "dataProvider": "ISS"
          }
          ```

      tags:
        - 'EVA Employment Verification API v2 (IMSS - ISSSTE)'
      operationId: 'employmentverificationsWithPrivacyNoticeIss'
      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: 'Signature created with your private key (SHA256withECDSA - secp384r). API Hub verifies the signature matches with the URL using your public key. Your public key must be uploaded in the API Hub Portal Applications section.'
        required: true
        schema:
          type: 'string'
      requestBody:
        description: 'Input parameters in order to start an employment verification process.'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmploymentVerificationWithPrivacyNoticeIss'
      responses:
        '200':
          description: 'OK - Returns an employment verification request acknowledge.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckEVRequest'
        '400':
          description: 'Bad request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                missingParameters:
                  summary: 'Missing parameters example'
                  value:
                    errors:
                      - code: "400"
                        message: "Missing parameters {employmentVerificationRequestId, subscriptionId, curp, email}"
        '401':
          description: 'Unauthorized.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                invalidApiKey:
                  summary: 'Invalid API Key'
                  value:
                    errors:
                      - code: '401.1'
                        message: 'Unauthorized, invalid x-api-key.'
                invalidCredentials:
                  summary: 'Invalid Credentials'
                  value:
                    errors:
                      - code: '401.2'
                        message: 'Unauthorized, invalid credentials.'
                noProduct:
                  summary: 'No Product'
                  value:
                    errors:
                      - code: '401.3'
                        message: 'Unauthorized, you do not have the product.'
                noAccess:
                  summary: 'No Access'
                  value:
                    errors:
                      - code: '401.4'
                        message: 'Unauthorized, you do not have access to the resource.'
        '403':
          description: 'Forbidden.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                invalidSignature:
                  summary: 'Invalid Signature'
                  value:
                    errors:
                      - code: '403.1'
                        message: 'We could not verify the signature, x-signature is invalid.'
        '429':
          description: 'Too many requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                tooManyRequests:
                  summary: 'Too Many Requests'
                  value:
                    errors:
                      - code: "429"
                        message: "Too many requests."
        '500':
          description: 'Internal server error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                internalError:
                  summary: 'Internal Error'
                  value:
                    errors:
                      - code: "500"
                        message: "There was an unexpected error, try again later."
        '503':
          description: 'Service unavailable.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                serviceUnavailable:
                  summary: 'Service Unavailable'
                  value:
                    errors:
                      - code: "503"
                        message: "Service unavailable."
  /v2/eva/employmentverifications/{inquiryId}:
    get:
      summary: 'Returns the employment verification process payload.'
      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:**

              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. |
      tags:
        - 'EVA Employment Verification API v2 (IMSS - ISSSTE)'
      operationId: 'getEmploymentVerificationIss'
      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: 'Signature created with your private key (SHA256withECDSA - secp384r). API Hub verifies the signature matches with the URL using your public key. Your public key must be uploaded in the API Hub Portal Applications section.'
        required: true
        schema:
          type: 'string'
      - name: inquiryId
        in: path
        description: The identifier of the inquiry.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: 'OK - Returns the employment verification process information.'
          headers:
            x-signature:
              description: 'Signature created with the Círculo de Crédito private key (SHA256withECDSA - secp384r). You must verify the signature matches with the response body using the Círculo de Crédito public key. The Círculo de Crédito public key must be downloaded from the API Hub Portal Applications section.'
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckSuccessEVConsumptionISSSTE'
        '400':
          description: 'Bad request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                missingParameters:
                  summary: 'Missing Parameters'
                  value:
                    errors:
                      - code: "400"
                        message: "Missing parameters {x-api-key}."
        '401':
          description: 'Unauthorized.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                invalidApiKey:
                  summary: 'Invalid API Key'
                  value:
                    errors:
                      - code: '401.1'
                        message: 'Unauthorized, invalid x-api-key.'
                invalidCredentials:
                  summary: 'Invalid Credentials'
                  value:
                    errors:
                      - code: '401.2'
                        message: 'Unauthorized, invalid credentials.'
                noProduct:
                  summary: 'No Product'
                  value:
                    errors:
                      - code: '401.3'
                        message: 'Unauthorized, you do not have the product.'
                noAccess:
                  summary: 'No Access'
                  value:
                    errors:
                      - code: '401.4'
                        message: 'Unauthorized, you do not have access to the resource.'
        '403':
          description: 'Forbidden.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                invalidSignature:
                  summary: 'Invalid Signature'
                  value:
                    errors:
                      - code: '403.1'
                        message: 'We could not verify the signature, x-signature is invalid.'
        '404':
          description: 'Inquiry not found.'
          headers:
            x-signature:
              description: 'Signature created with the Círculo de Crédito private key (SHA256withECDSA - secp384r). You must verify the signature matches with the response body using the Círculo de Crédito public key. The Círculo de Crédito public key must be downloaded from the API Hub Portal Applications section.'
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckFailureEVConsumption'
              examples:
                inquiryNotFound:
                  summary: 'Inquiry Not Found'
                  value:
                    acknowledgeId: 45f53c81-04e0-42df-abd8-de217e2edf2a
                    dateTime: '2020-09-01T03:36:38Z'
                    operation: consume
                    message: 'The request has been consumed.'
                    employmentVerification:
                      errors:
                        - code: '400'
                          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.'
                      request:
                        employmentVerificationRequestId: 23fa2ec7-3294-4aa4-ba65-a0f49a75bfc4
                        subscriptionId: 51752e30-eab2-4368-a4eb-ce5a34d90f04
                        inquiryId: a99c3501-7b3a-4b3e-8ca5-1e48225b8176
                        curp: PUPJ970229HDFZZG61
                        email: api61@circulodecredito.com.mx
                        inquiryStatus: DN
                        successCheck: false
        '410':
          description: 'Gone - The maximum time in order to obtain the payload has expired: 30 days.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                payloadExpired:
                  summary: 'Payload Expired'
                  value:
                    errors:
                      - code: "410"
                        message: "The maximum time in order to obtain the payload has expired."
        '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'
              examples:
                tooEarly:
                  summary: 'Too Early'
                  value:
                    errors:
                      - code: "425"
                        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'
              examples:
                tooManyRequests:
                  summary: 'Too Many Requests'
                  value:
                    errors:
                      - code: "429"
                        message: "Too many requests."
        '500':
          description: 'Internal server error.'
          headers:
            x-signature:
              description: 'Signature created with the Círculo de Crédito private key (SHA256withECDSA - secp384r). You must verify the signature matches with the response body using the Círculo de Crédito public key. The Círculo de Crédito public key must be downloaded from the API Hub Portal Applications section.'
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AckFailureEVConsumption'
              examples:
                internalError:
                  summary: 'Internal Error'
                  value:
                    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."
                      request:
                        employmentVerificationRequestId: d029a1ba-3566-4361-834a-f44add8cc4f7
                        subscriptionId: 51752e30-eab2-4368-a4eb-ce5a34d90f04
                        inquiryId: 43d21139-e1fa-4768-8b78-79aa3ca1993f
                        curp: PUPJ970229HDFZZG70
                        email: api70@circulodecredito.com.mx
                        inquiryStatus: RI
                        successCheck: false
        '503':
          description: 'Service unavailable.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              examples:
                serviceUnavailable:
                  summary: 'Service Unavailable'
                  value:
                    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
      - TAMP
      - TLAX
      - VER
      - YUC
      - ZAC
    EmploymentVerificationWithPrivacyNotice:
      required:
      - employmentVerification
      - privacyNotice
      type: object
      properties:
        privacyNotice:
          $ref: '#/components/schemas/PrivacyNotice'
        employmentVerification:
          $ref: '#/components/schemas/EmploymentVerification'
      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.
    EmploymentVerification:
      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).
          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
        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'
        inquiryStatus:
          type: 'string'
          description: 'Inquiry status.'
          enum: ["RI", "SN", "DN", "DND", "CI"]
          example: 'DN'
          readOnly: true
        successCheck:
          description: 'It is true if the employment verification process ended successfully.'
          type: 'boolean'
          example: true
          readOnly: true
        processingModel:
          type: 'string'
          description: '"ENRICHED|GATEGAWAY" (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

    EmploymentVerificationIss:
      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
        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
        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
        dataProvider:
          maxLength: 3
          minLength: 3
          type: string
          description: Souce (Provider)<table><thead><tr><th>Identifier</th><th>Name</th></tr></thead><tbody><tr><td>IMS</td><td>IMSS</td></tr><tr><td>ISS</td><td>ISSSTE</td></tr></tbody></table>
          example: ISS
          enum: ["IMS", "ISS"]

    EmploymentVerifications:
      type: array
      description: A list of employment verification processes.
      items:
        $ref: '#/components/schemas/EmploymentVerification'
    EmploymentVerificationMetadata:
      type: object
      properties:
        _metadata:
          $ref: '#/components/schemas/Metadata'
        inquiries:
          $ref: '#/components/schemas/EmploymentVerifications'
      description: Metadata (paging information) of the list of employment verification
        processes.
    EmploymentVerificationWithPrivacyNoticeIss:
      title: EmploymentVerificationWithPrivacyNotice
      description: Employment verification information. It must include the the privacy notice customer acceptance.
      type: object
      required:
      - employmentVerification
      - privacyNotice
      properties:
        privacyNotice:
          $ref: '#/components/schemas/PrivacyNotice'
        employmentVerification:
          $ref: '#/components/schemas/EmploymentVerificationIss'
    SuccessEVConsumptionIMSS:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/EmploymentVerification'
        names:
          type: string
          description: Concatenation of firstname and surname.
          readOnly: true
          example: VICENTE RAMON GUERRERO SALDAÑA
        birthday:
          type: string
          description: Birthday. As defined by full-date RFC3339.
          format: date
          readOnly: true
          example: 1829-04-01
        workStatus:
          type: string
          description: Work status.
          readOnly: true
          enum:
          - W
          - NW
        validUntil:
          type: string
          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.
          format: date
          readOnly: true
          example: 1829-04-01
        workingHistory:
          $ref: '#/components/schemas/WorkingHistory'
      description: Information about a successful employment verification process.
    SuccessEVConsumptionISSSTE:
      title: SuccessEVConsumptionISSSTE
      description: Information about a successful employment verification process.
      type: object
      properties:
        curp:
          description: CURP (loan/credit applicant MX Id).
          example: DISG521217
          readOnly: true
          type: string
        request:
          type: object
          allOf:
            - $ref: '#/components/schemas/EmploymentVerification'
            - description: Employment verification information
        names:
          description: Concatenation of firstname and surname.
          example: JUAN TEST
          readOnly: true
          type: string
        rfc:
          description: RFC (loan/credit applicant MX Id).
          example: TEST521217
          readOnly: true
          type: string
        gender:
          type: object
          allOf:
            - $ref: '#/components/schemas/Gender'
            - description: Gender with which the person registered.
              example: MUJER
              readOnly: true
        birthday:
          description: Birthday. As defined by full-date RFC3339.
          example: 1829-04-01
          readOnly: true
          type: string
          format: date
        civilState:
          type: object
          allOf:
            - $ref: '#/components/schemas/CivilState'
            - description: Civil state
              example: CASADO (A)
              readOnly: true
        nss:
          example: '80995206994'
          readOnly: true
          type: string
        startDateRLastPosition:
          description: Last employment registration date. As defined by full-date RFC3339.
          example: 2002-02-16
          readOnly: true
          type: string
          format: date
        dateEntryFederalGovernment:
          description: Date of entry into the Federal Government. As defined by full-date RFC3339.
          example: 1999-05-01
          readOnly: true
          type: string
          format: date
        endDateRLastPosition:
          description: Last employment registration date. As defined by full-date RFC3339.
          readOnly: true
          type: string
          format: date
        accessMedicalService:
          type: object
          example: 'Y'
          allOf:
            - $ref: '#/components/schemas/AccessMedicalService'
            - description: Work status.
              readOnly: true
        typeBeneficiary:
          type: object
          allOf:
            - $ref: '#/components/schemas/TypeBeneficiary'
            - example: TRABAJADOR
              readOnly: true
        affiliationStatus:
          type: object
          allOf:
            - $ref: '#/components/schemas/AffiliationStatus'
            - example: INACTIVO
              readOnly: true
        laborData:
          description: Detail of the user’s working history
          type: array
          items:
            $ref: '#/components/schemas/LaborDataDetail'
        address:
          $ref: '#/components/schemas/AddressDetail'
        clinic:
          $ref: '#/components/schemas/ClinicDetail'
        status:
          description: Status of the response
          example: OK
          readOnly: true
          type: string
        validationCode:
          description: Unique validation execution code.
          example: gi1621387427.1002612
          readOnly: true
          type: string
        messageCode:
          description: Message Code.
          example: '0'
          readOnly: true
          type: string
        workStatus:
          description: 'Work status.'
          type: 'string'
          enum: [ 'W', 'NW' ]
          readOnly: true
    FailureEVConsumption:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/EmploymentVerification'
        errors:
          type: array
          description: List of errors.
          items:
            $ref: '#/components/schemas/Error'
      description: Information about a failed employment verification process.
    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'
    AckSuccessEVConsumptionISSSTE:
      title: AckSuccessEVConsumptionISSSTE
      description: Acknowledge of a successful employment verification process ISSSTE.
      allOf:
        - $ref: '#/components/schemas/AckEmploymentVerification'
        - type: object
          properties:
            employmentVerification:
              type: object
              allOf:
                - $ref: '#/components/schemas/SuccessEVConsumptionISSSTE'
                - description: Information about a successful employment verification process.
    AckFailureEVConsumption:
      description: Acknowledge of an unsuccessful employment verification process.
      allOf:
        - $ref: '#/components/schemas/AckEmploymentVerification'
    AckEVRequest:
      description: Acknowledge of an employment verification process.
      allOf:
        - $ref: '#/components/schemas/AckEmploymentVerification'
        - $ref: '#/components/schemas/EmploymentVerificationId'
    Error:
      type: object
      properties:
        code:
          type: string
          description: Error code.
          example: "400"
        message:
          maxLength: 120
          type: string
          description: Descriptive and human-readable error message.
          example: External data source not available.
      description: Error
    Errors:
      type: object
      properties:
        errors:
          type: array
          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/sandbox/v1/eva/employmentverifications?page=7&perPage=15
        first:
          type: string
          description: URL of the first page.
          readOnly: true
          example: https://services.circulodecredito.com.mx/sandbox/v1/eva/employmentverifications?page=1&perPage=15
        previous:
          type: string
          description: URL of the previous page.
          readOnly: true
          example: https://services.circulodecredito.com.mx/sandbox/v1/eva/employmentverifications?page=6&perPage=15
        next:
          type: string
          description: URL of the next page.
          readOnly: true
          example: https://services.circulodecredito.com.mx/sandbox/v1/eva/employmentverifications?page=8&perPage=15
        last:
          type: string
          description: URL of the last page.
          readOnly: true
          example: https://services.circulodecredito.com.mx/sandbox/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: 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
    Type:
      title: Type
      description: Clinic type.
      example: CAF
      type: string
      enum:
        - CMF
        - CH
        - CAF
    ClinicDetail:
      title: ClinicDetail
      type: object
      properties:
        key:
          description: Clinic key.
          example: '1521600'
          type: string
        type:
          type: object
          allOf:
            - $ref: '#/components/schemas/Type'
            - description: Clinic type.
              example: CAF
        name:
          description: Name of clinic.
          example: CUAUTITLAN IZCALLI
          type: string
        address:
          description: Address of clinic.
          example: CALLE DE LOS OCEANOS Nº 3, ATLANTA
          type: string
        isssteDelegation:
          description: ISSSTE clinic delegation.
          example: DELEGACION ESTATAL EN EL ESTADO DE MEXICO
          type: string
  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
