openapi: 3.0.0
info:
  title: IPAddressInfo
  description: >
    Strengthen your loan origination process with our powerful IP Address verification tool. By analyzing an applicant’s IP, you can instantly retrieve critical data such as country, region/state, city, zip/postal codes, connection type, and latitude/longitude to detect inconsistencies and potential fraud.


    This tool helps lenders validate proxies, identify VPN usage, and flag darknet nodes—key indicators of fraudulent loan applications. With real-time insights, financial institutions can prevent identity theft, reduce risk exposure, and ensure regulatory compliance before approving loans.


    Enhance your decision-making and protect your business with precise IP intelligence.
  version: 1.0.0.0
paths:
  /:
    post:
      summary: ''
      description: IP Address Info
      operationId: /
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPAddressInfoRq_Type'
            examples:
              INVALID:
                value: >-
                  {
                    "IP": "0.0.0.0"
                  }
              VALID1:
                value: >-
                  {
                    "IP": "172.217.11.4"
                  }
          application/xml:
            schema:
              $ref: '#/components/schemas/IPAddressInfoRq_Type'
            examples:
              INVALID:
                value: >-
                  <IPAddressInfoRq>
                    <IP>0.0.0.0</IP>
                  </IPAddressInfoRq>
              VALID1:
                value: >-
                  <IPAddressInfoRq>
                    <IP>172.217.11.4</IP>
                  </IPAddressInfoRq>
        required: true
        x-position: 1
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IPAddressInfoRs_Type'
            application/xml:
              schema:
                $ref: '#/components/schemas/IPAddressInfoRs_Type'
      security:
      - oauth: []
components:
  schemas:
    IPAddressInfoRs_Type:
      type: object
      properties:
        MsgRsHdr:
          $ref: '#/components/schemas/MsgRsHdr_Type'
        IpInfo:
          $ref: '#/components/schemas/IpInfo'
    MsgRsHdr_Type:
      type: object
      properties:
        RqUID:
          type: string
        Status:
          $ref: '#/components/schemas/Status_Type'
    Status_Type:
      type: object
      properties:
        StatusCode:
          type: integer
          format: int64
        ServerStatusCode:
          type: string
        Severity:
          $ref: '#/components/schemas/Severity_Type'
        StatusDesc:
          type: string
        AdditionalStatus:
          type: array
          items:
            $ref: '#/components/schemas/AdditionalStatus_Type'
    Severity_Type:
      type: string
      description: ''
      x-enumNames:
      - Error
      - Warn
      - Info
      enum:
      - Error
      - Warn
      - Info
    AdditionalStatus_Type:
      type: object
      properties:
        StatusCode:
          type: integer
          format: int64
        StatusCodeSpecified:
          type: boolean
        ServerStatusCode:
          type: string
        Severity:
          $ref: '#/components/schemas/Severity_Type'
        StatusDesc:
          type: string
    IpInfo:
      type: object
      properties:
        IP:
          type: string
        Country:
          type: string
        Region:
          type: string
        City:
          type: string
        Speed:
          type: string
        Country_c:
          type: integer
          format: int32
          nullable: true
        Region_c:
          type: integer
          format: int32
          nullable: true
        City_c:
          type: integer
          format: int32
          nullable: true
        Metro_code:
          type: integer
          format: int32
          nullable: true
        Latitude:
          type: number
          format: double
          nullable: true
        Longitude:
          type: number
          format: double
          nullable: true
        CountryCode:
          type: integer
          format: int32
          nullable: true
        RegionCode:
          type: integer
          format: int32
          nullable: true
        CityCode:
          type: integer
          format: int32
          nullable: true
        ContinentCode:
          type: integer
          format: int32
          nullable: true
    IPAddressInfoRq_Type:
      type: object
      properties:
        MsgRqHdr:
          $ref: '#/components/schemas/MsgRqHdr_Type'
        IP:
          type: string
    MsgRqHdr_Type:
      type: object
      properties:
        MemberId:
          type: string
        MemberPwd:
          type: string
        RequestType:
          $ref: '#/components/schemas/RequestType'
        RequestTypeSpecified:
          type: boolean
        ReasonCode:
          type: string
        GLBPurpose:
          type: string
        DLPurpose:
          type: string
        RefNum:
          type: string
        UserName:
          type: string
        Timeout:
          type: integer
          format: int64
        TimeoutSpecified:
          type: boolean
        FrozenFilePIN:
          type: string
        OutputFormat:
          type: string
        ProductID:
          type: string
    RequestType:
      type: string
      description: ''
      x-enumNames:
      - I
      - J
      - N
      - A
      - W
      - S
      - P
      - B
      - R
      enum:
      - I
      - J
      - N
      - A
      - W
      - S
      - P
      - B
      - R
  securitySchemes:
    oauth:
      type: oauth2
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://apitest.microbilt.com/OAuth/Token
servers:
- url: https://api.microbilt.com/IPAddressInfo
  description: Production url
- url: https://apitest.microbilt.com/IPAddressInfo
  description: Sandbox url
x-name: IPAddressInfo