Signicat Accounts And Attributes API

openapi: 3.2.0
info:
  title: Signicat Accounts And Attributes API
  version: v1
  contact: ''
  license: ''
  termsOfService: ''
  description: 'Operations tagged AccountsAndAttributes across 2 of this provider''s published API definitions: data-verification-openapi.json, signicat-data-verification-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.signicat.com/info/lookup
tags:
- name: AccountsAndAttributes
  description: 'This API returns information about a account.


    Learn more about the different data sources in the developer documentation.

    Also, refer to Sources section (below) to learn how to configure the data sources which you would like to use.'
paths:
  /accountsAndAttributes/fraudRisk:
    get:
      tags:
      - AccountsAndAttributes
      summary: Fraud Risk
      description: Retrieve risk of fraud
      operationId: AccountsAndAttributes_GetFraudRisk_GET
      parameters:
      - name: email
        in: query
        description: The email address to be checked for risk.
        schema:
          type: string
      - name: phoneNumber
        in: query
        description: The phone number to be checked for risk.
        schema:
          type: string
      - name: ipAddress
        in: query
        description: The IP address to be checked for risk.
        schema:
          type: string
      - name: country
        in: query
        description: Country connected with the phoneNumber. ISO 3166-1 country code. This is an optional parameter and usage would depend on the source.
        schema:
          type: string
      - name: source
        in: query
        description: Optional name of the source to use
        schema:
          maxLength: 50
          type: string
      - name: rawJson
        in: query
        description: Optionally include the raw data received from the upstream if supported by the source
        schema:
          type: boolean
      responses:
        '200':
          description: Risk of Fraud was found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountsAndAttributes.FraudRiskDto'
        '400':
          description: Request has errors
        '401':
          description: Unauthorized to do the request
        '403':
          description: Forbidden to do the request
        '404':
          description: No risk of fraud was found
    servers:
    - url: https://api.signicat.com/info/lookup
components:
  schemas:
    AccountsAndAttributes.FraudRiskDto:
      type: object
      properties:
        email:
          $ref: '#/components/schemas/AccountsAndAttributes.EmailInfo'
        phoneNumber:
          $ref: '#/components/schemas/AccountsAndAttributes.PhoneNumberInfo'
        ipAddress:
          $ref: '#/components/schemas/AccountsAndAttributes.IpAddressInfo'
        metadata:
          $ref: '#/components/schemas/MetadataDto'
      additionalProperties: false
    AccountsAndAttributes.GeoLocation:
      type: object
      properties:
        country:
          type:
          - string
          - 'null'
          description: The country associated with the IP address.
        region:
          type:
          - string
          - 'null'
          description: The region or state associated with the IP address.
        city:
          type:
          - string
          - 'null'
          description: The city associated with the IP address.
      additionalProperties: false
    AccountsAndAttributes.PhoneNumberType:
      enum:
      - mobile
      - voip
      - landline
      - tollfree
      - premium
      - voicemail
      - prepaid
      - payphone
      - pager
      - invalid
      - unknown
      type: string
    MetadataDto:
      type: object
      properties:
        sources:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of sources for the data
        urls:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Public urls to the sources
        lastChanged:
          type:
          - string
          - 'null'
          description: The date the data was last changed
          format: date-time
        rawJson:
          type:
          - string
          - 'null'
          description: The raw JSON if it was requested and supported by the source
        isCache:
          type: boolean
          description: Return boolean whether data is retrieved from cache.
      additionalProperties: false
      description: Metadata about the response
    AccountsAndAttributes.PhoneNumberInfo:
      type: object
      properties:
        valid:
          type: boolean
          description: Indicates whether the phone number is valid.
        riskScore:
          type: number
          description: A numerical score representing the risk associated with the phone number.
          format: double
        isDisposable:
          type: boolean
          description: Indicates whether the phone number is disposable (e.g., temporary).
        type:
          $ref: '#/components/schemas/AccountsAndAttributes.PhoneNumberType'
        carrier:
          type:
          - string
          - 'null'
          description: The carrier or service provider associated with the phone number.
        country:
          type:
          - string
          - 'null'
          description: The country code associated with the phone number.
        remarks:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Additional notes or comments about the Phone Info.
      additionalProperties: false
    AccountsAndAttributes.EmailInfo:
      type: object
      properties:
        valid:
          type: boolean
          description: Indicates whether the email is valid.
        riskScore:
          type: number
          description: A numerical score representing the risk associated with the email.
          format: double
        isDeliverable:
          type: boolean
          description: Indicates if the mail can be delivered to the mail id provided.
        age:
          type: number
          description: Indicates the age of the email in months
          format: double
        domain:
          $ref: '#/components/schemas/AccountsAndAttributes.DomainInfo'
        remarks:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Additional notes or comments about the Email.
      additionalProperties: false
    AccountsAndAttributes.DomainInfo:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name of the Domain
        createdDate:
          type:
          - string
          - 'null'
          description: Creation Date of the Domain
          format: date-time
        isDisposable:
          type: boolean
          description: Indicates whether the Domain is disposable
      additionalProperties: false
    AccountsAndAttributes.IpAddressInfo:
      type: object
      properties:
        isRisky:
          type: boolean
          description: Indicates whether the IP address is considered risky.
        riskScore:
          type: number
          description: A numerical score representing the risk associated with the IP address.
          format: double
        lastSeenDays:
          type:
          - integer
          - 'null'
          description: The number of days since the IP address was last seen.
          format: int32
        vpn:
          type: boolean
          description: Indicates if the IP is using vpn service.
        geoLocation:
          $ref: '#/components/schemas/AccountsAndAttributes.GeoLocation'
        remarks:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Additional notes or comments about the IP address.
      additionalProperties: false
x-refined-from:
- data-verification-openapi.json
- signicat-data-verification-openapi.yml