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

# Work Email → Personal Email

> Match a work email to a hashed personal email.

Provide a valid plaintext work `email`. On a match, the response contains the person's personal email addresses as SHA-256 hashes; on a miss the `personal_email_sha256s` array is empty.

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



## OpenAPI

````yaml POST /api/v1/business_email_to_personal_hem
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/business_email_to_personal_hem:
    post:
      tags:
        - Email
      summary: Work Email → Personal Email
      description: >-
        Match a work email to a hashed personal email.


        Provide a valid plaintext work `email`. On a match, the response
        contains the person's personal email addresses as SHA-256 hashes; on a
        miss the `personal_email_sha256s` array is empty.


        **Billing:** 1 credit per successful match (HTTP 200). Misses (404) and
        request errors (4xx) are not billed.
      operationId: businessEmailToPersonalHem
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - email
              properties:
                email:
                  type: string
                  format: email
                  description: Plaintext work email address. Must be a valid email address.
                  example: alice@acme.com
        required: true
      responses:
        '200':
          description: Personal hashed emails found (1 credit charged)
          content:
            application/json:
              schema:
                type: object
                required:
                  - results
                properties:
                  results:
                    type: object
                    required:
                      - personal_email_sha256s
                    properties:
                      personal_email_sha256s:
                        type: array
                        items:
                          type: string
                          example: >-
                            2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824
                        description: >-
                          SHA-256 hashes of the personal email addresses matched
                          to the supplied work email. Deduplicated; at least one
                          entry on HTTP 200.
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                    enum:
                      - missing email
                      - invalid email
                      - unexpected connection error
                      - unexpected error
                    description: >-
                      `missing email`: no email was provided. `invalid email`:
                      the input is not a valid email 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 match found (not billed)
          content:
            application/json:
              schema:
                type: object
                required:
                  - results
                properties:
                  results:
                    type: object
                    required:
                      - personal_email_sha256s
                    properties:
                      personal_email_sha256s:
                        type: array
                        items:
                          type: string
                        maxItems: 0
                        description: >-
                          Always empty; no personal emails matched the supplied
                          work email.
      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.