> ## Documentation Index
> Fetch the complete documentation index at: https://retention.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# IP → Business Profile

> Resolve an IP (and browser details) straight to one work profile: name, title, company, and seniority. You're only charged when a profile is returned.

Provide an IPv4 or IPv6 `ip_address`, optionally with the visitor's `user_agent`. The first available work profile is returned using our proprietary identity resolution technology. Email fields are MD5-hashed by default.

**Billing:** 3 credits per successful match (HTTP 200). Misses (404) and request errors (4xx) are not billed.



## OpenAPI

````yaml POST /api/v1/ip_to_business_profile
openapi: 3.0.1
info:
  title: Retention API
  version: v1
  description: Retention.com identity & data resolution APIs.
servers:
  - url: https://api.rb2b.com
security: []
tags:
  - name: Identity
    description: >-
      Core Identity. Resolve a hashed email (or batch) into a shaped person
      profile.
paths:
  /api/v1/ip_to_business_profile:
    post:
      tags:
        - IP
      summary: IP → Business Profile
      description: >-
        Resolve an IP (and browser details) straight to one work profile: name,
        title, company, and seniority. You're only charged when a profile is
        returned.


        Provide an IPv4 or IPv6 `ip_address`, optionally with the visitor's
        `user_agent`. The first available work profile is returned using our
        proprietary identity resolution technology. Email fields are MD5-hashed
        by default.


        **Billing:** 3 credits per successful match (HTTP 200). Misses (404) and
        request errors (4xx) are not billed.
      operationId: ipToBusinessProfile
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - ip_address
              properties:
                ip_address:
                  type: string
                  description: IPv4 or IPv6 address of the visitor.
                  example: 203.0.113.42
                user_agent:
                  type: string
                  description: >-
                    Visitor's browser User-Agent. Optional; improves match
                    confidence when provided.
                  example: >-
                    Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
                    AppleWebKit/537.36
                include_mobile_phone:
                  type: boolean
                  default: false
                  description: >-
                    Also look up the contact's mobile phone number and include
                    it as `mobile_phone` in the result.
                require_email:
                  type: boolean
                  default: false
                  description: >-
                    Only return and bill for profiles that contain an email
                    address.
        required: true
      responses:
        '200':
          description: Profile found (3 credits charged)
          content:
            application/json:
              schema:
                type: object
                required:
                  - result
                properties:
                  result:
                    type: object
                    description: >-
                      Work profile for the matched contact. Only fields known
                      for the contact are present.
                    additionalProperties: true
                    properties:
                      first_name:
                        type: string
                        example: Alice
                      last_name:
                        type: string
                        example: Smith
                      title:
                        type: string
                        example: VP of Marketing
                      seniority:
                        type: string
                        example: vp
                      functional_area:
                        type: string
                        example: Marketing
                      current_company:
                        type: string
                        description: Company name (title-cased).
                        example: Acme
                      current_industry:
                        type: string
                        example: Computer Software
                      country:
                        type: string
                        example: United States
                      linkedin_slug:
                        type: string
                        description: LinkedIn public profile slug.
                        example: alice-123
                      company_employee_range:
                        type: string
                        nullable: true
                        example: 51-200
                      company_revenue_range:
                        type: string
                        nullable: true
                        example: $10M-$50M
                      work_email_confirmed:
                        type: string
                        description: Confirmed work email, returned as an MD5 hash.
                        example: 5f60af2947b32bde4bc824a30ad3f919
                      personal_emails:
                        type: array
                        items:
                          type: string
                        description: Personal email addresses, returned as MD5 hashes.
                      mobile_phone:
                        type: string
                        nullable: true
                        description: >-
                          Mobile phone number. Present only when
                          `include_mobile_phone` was requested.
                        example: '+14155550123'
        '400':
          description: Missing, invalid, or temporarily unavailable
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - missing ip_address
                      - invalid ip_address
                      - unexpected connection error
                      - unexpected error
                    description: >-
                      `missing ip_address`: no `ip_address` was provided.
                      `invalid ip_address`: the value is not a valid IPv4 or
                      IPv6 address. `unexpected connection error` / `unexpected
                      error`: temporary error; safe to retry.
        '401':
          description: Missing, malformed, or unknown API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '402':
          description: Insufficient credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsufficientCreditsError'
        '403':
          description: Service not enabled for this API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceDisabledError'
        '404':
          description: No profile found (not billed)
          content:
            application/json:
              schema:
                type: object
                required:
                  - result
                properties:
                  result:
                    type: object
                    description: Empty object; no work profile matched the supplied IP.
                    maxProperties: 0
      security:
        - api_key: []
components:
  schemas:
    AuthError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          enum:
            - missing_api_key
            - invalid_api_key_format
            - invalid_api_key
          description: >-
            `missing_api_key`: no key supplied. `invalid_api_key_format`: key
            does not match the expected format. `invalid_api_key`: key does not
            belong to any account.
    InsufficientCreditsError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          enum:
            - insufficient_api_credits
        required:
          type: string
          description: Credits needed for this request.
          example: '1.0'
        remaining:
          type: string
          description: Credits currently remaining on the account.
          example: '0.0'
    ServiceDisabledError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          enum:
            - service_unavailable_for_key
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Per-account API key. Also accepted as `Api-Key` or `Authorization:
        Bearer <key>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.