> ## Documentation Index
> Fetch the complete documentation index at: https://umbrella-docs.info/llms.txt
> Use this file to discover all available pages before exploring further.

# Full Phone Intelligence Service

> Full Phone Intelligence Service API Documentation

For a usage description of the Full Phone Intelligence Service, please refer to the [Full Phone Intelligence](/essentials/phoneServices) page.

## Endpoint

**POST** `/phone-service/fullPhoneIntelligence`

## Swagger

<a href="/public/downloads/swagger/phoneServices/phoneService.postman_collection.json" download="phoneService.postman_collection.json">
  <button>⬇️ Download OpenAPI YAML</button>
</a>


## OpenAPI

````yaml POST /phone-service/fullPhoneIntelligence
openapi: 3.1.0
info:
  title: Umbrella API
  version: 1.0.0
  description: >-
    API documentation for Umbrella services including KYB, KYC, AML, payments,
    phone intelligence, onboarding, and address verification.
servers:
  - url: https://api-umbrella.io/api/services
    description: Production
  - url: https://sandbox-umbrella-api.azurewebsites.net/api/services
    description: Sandbox
security:
  - bearerAuth: []
paths:
  /phone-service/fullPhoneIntelligence:
    post:
      summary: Full Phone Intelligence
      description: >-
        Comprehensive risk and identity assessment for a phone number combining
        behavioral signals, telecom intelligence, and historical data.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FullPhoneIntelligenceRequest'
            examples:
              default:
                value:
                  phoneNumber: '+436501234567'
      responses:
        '200':
          description: Successfully retrieved full phone intelligence.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullPhoneIntelligenceResponse'
              examples:
                default:
                  value:
                    status: true
                    data:
                      referenceId: 3661FDC54750091C93078058241C3036
                      externalId: null
                      status:
                        updatedOn: '2025-08-06T12:53:09.929413Z'
                        code: 300
                        description: Transaction successfully completed
                      numbering:
                        original:
                          completePhoneNumber: '+436501234567'
                          countryCode: '43'
                          phoneNumber: '6501234567'
                        cleansing:
                          call:
                            countryCode: '43'
                            phoneNumber: '6501234567'
                            cleansedCode: 100
                            minLength: 7
                            maxLength: 13
                          sms:
                            countryCode: '43'
                            phoneNumber: '6501234567'
                            cleansedCode: 100
                            minLength: 7
                            maxLength: 13
                      riskInsights:
                        status: 800
                        category:
                          - 10010
                        a2P:
                          - 22007
                          - 20011
                          - 20101
                        p2P:
                          - 30201
                        numberType: []
                        ip: []
                        email: []
                      phoneType:
                        code: '2'
                        description: MOBILE
                      location:
                        city: Countrywide
                        state: null
                        zip: null
                        metroCode: null
                        county: null
                        country:
                          name: Austria
                          iso2: AT
                          iso3: AUT
                        coordinates:
                          latitude: null
                          longitude: null
                        timeZone:
                          name: null
                          utcOffsetMin: '+1'
                          utcOffsetMax: '+1'
                      carrier:
                        name: T-Mobile Austria GmbH
                      blocklisting:
                        blocked: false
                        blockCode: 0
                        blockDescription: Not blocked
                      risk:
                        level: medium-low
                        recommendation: allow
                        score: 301
        '400':
          description: Bad Request - Malformed syntax in the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized - Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '404':
          description: Not Found - The server could not find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '429':
          description: Too Many Requests - Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '503':
          description: Service Unavailable - System is temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error503'
components:
  schemas:
    FullPhoneIntelligenceRequest:
      type: object
      required:
        - phoneNumber
      properties:
        phoneNumber:
          type: string
          description: Phone number to check, including country code (E.164).
          example: '+436501234567'
    FullPhoneIntelligenceResponse:
      type: object
      required:
        - status
        - data
      properties:
        status:
          type: boolean
          description: Indicates if the API request was successful.
        data:
          type: object
          properties:
            referenceId:
              type: string
              description: Unique reference ID for the transaction.
            externalId:
              type: string
              nullable: true
              description: External reference ID (nullable).
            status:
              type: object
              properties:
                updatedOn:
                  type: string
                  description: Timestamp of the last update (ISO 8601 format).
                code:
                  type: number
                  description: Status code (e.g., 300 for success).
                description:
                  type: string
                  description: Status description message.
            numbering:
              type: object
              properties:
                original:
                  type: object
                  properties:
                    completePhoneNumber:
                      type: string
                    countryCode:
                      type: string
                    phoneNumber:
                      type: string
                cleansing:
                  type: object
                  properties:
                    call:
                      type: object
                      properties:
                        countryCode:
                          type: string
                        phoneNumber:
                          type: string
                        cleansedCode:
                          type: number
                        minLength:
                          type: number
                        maxLength:
                          type: number
                    sms:
                      type: object
                      properties:
                        countryCode:
                          type: string
                        phoneNumber:
                          type: string
                        cleansedCode:
                          type: number
                        minLength:
                          type: number
                        maxLength:
                          type: number
            riskInsights:
              type: object
              description: Risk assessment details.
              properties:
                status:
                  type: number
                category:
                  type: array
                  items:
                    type: number
                a2P:
                  type: array
                  items:
                    type: number
                p2P:
                  type: array
                  items:
                    type: number
                numberType:
                  type: array
                  items:
                    type: number
                ip:
                  type: array
                  items:
                    type: number
                email:
                  type: array
                  items:
                    type: number
            phoneType:
              type: object
              properties:
                code:
                  type: string
                description:
                  type: string
            location:
              type: object
              properties:
                city:
                  type: string
                  nullable: true
                state:
                  type: string
                  nullable: true
                zip:
                  type: string
                  nullable: true
                metroCode:
                  type: string
                  nullable: true
                county:
                  type: string
                  nullable: true
                country:
                  type: object
                  properties:
                    name:
                      type: string
                    iso2:
                      type: string
                    iso3:
                      type: string
                coordinates:
                  type: object
                  properties:
                    latitude:
                      type: number
                      nullable: true
                    longitude:
                      type: number
                      nullable: true
                timeZone:
                  type: object
                  properties:
                    name:
                      type: string
                      nullable: true
                    utcOffsetMin:
                      type: string
                    utcOffsetMax:
                      type: string
            carrier:
              type: object
              properties:
                name:
                  type: string
            blocklisting:
              type: object
              properties:
                blocked:
                  type: boolean
                blockCode:
                  type: number
                blockDescription:
                  type: string
            risk:
              type: object
              description: Overall risk score and recommendation.
              properties:
                level:
                  type: string
                  example: medium-low
                recommendation:
                  type: string
                  example: allow
                score:
                  type: number
                  example: 301
    Error400:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Invalid request payload
    Error401:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Unauthorized request
    Error404:
      type: object
      properties:
        message:
          type: string
          example: Journey not found
    Error429:
      type: object
      properties:
        error:
          type: string
          example: Too Many Requests
        message:
          type: string
          example: Rate limit exceeded.
        code:
          type: string
          example: '429'
    Error500:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Internal Server Error
    Error503:
      type: object
      properties:
        error:
          type: string
          example: Service Unavailable
        message:
          type: string
          example: Service is unavailable.
        code:
          type: string
          example: '503'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained from POST /auth. Valid for 60 minutes.

````