RevenueBase Contact Refresh API

The contact-refresh service from RevenueBase — resolves an email address to the person's current contact records so a stale CRM row can be reconnected to whoever that person is today. One operation (POST /v2/contact/refresh/email) plus shallow and deep health probes. Marketed on the pricing page as "Reconnect to find contacts who changed companies" and still labelled coming soon there, but the endpoint is live on api.revenuebase.ai and its OpenAPI 3.1.0 is published through the documentation host. Authenticates with the same API key, passed as X-Key, and is the only RevenueBase surface that returns RFC 9457 application/problem+json.

OpenAPI Specification

revenuebase-contact-refresh-openapi.json Raw ↑
{
  "openapi": "3.1.0",
  "info": {
    "title": "contact-refresh",
    "version": "dev"
  },
  "paths": {
    "/health": {
      "get": {
        "tags": [
          "health"
        ],
        "summary": "Shallow liveness probe",
        "operationId": "health_health_get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HealthResponse"
                }
              }
            }
          }
        }
      }
    },
    "/health/ready": {
      "get": {
        "tags": [
          "health"
        ],
        "summary": "Deep readiness probe \u2014 confirms DynamoDB connectivity",
        "operationId": "health_ready_health_ready_get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HealthResponse"
                }
              }
            }
          }
        }
      }
    },
    "/v2/contact/refresh/email": {
      "post": {
        "tags": [
          "v2"
        ],
        "summary": "Resolve an email to the person's current contacts",
        "operationId": "refresh_email_v2_contact_refresh_email_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RefreshEmailRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RefreshEmailResponse"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKeyHeader": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Contact": {
        "properties": {
          "RBID_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rbid Per"
          },
          "RBID_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rbid Org"
          },
          "RBID_PAO": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Rbid Pao"
          },
          "FIRST_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "First Name Per"
          },
          "MIDDLE_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Middle Name Per"
          },
          "LAST_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Last Name Per"
          },
          "SUFFIX_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Suffix Name Per"
          },
          "TITLE_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Title Name Per"
          },
          "FULL_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Full Name Per"
          },
          "EMAIL_ADDRESS_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Email Address Per"
          },
          "EMAIL_DOMAIN_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Email Domain Per"
          },
          "EMAIL_KEY": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Email Key"
          },
          "EMAIL_STATUS_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Email Status Per"
          },
          "EMAIL_LAST_VERIFIED_AT_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Email Last Verified At Per"
          },
          "HAS_EMAIL_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Has Email Per"
          },
          "HAS_PHONE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Has Phone Per"
          },
          "HAS_CELLPHONE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Has Cellphone Per"
          },
          "CELLPHONE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Cellphone Per"
          },
          "DIRECT_PHONE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Direct Phone Per"
          },
          "ABOUT_ME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "About Me Per"
          },
          "PERSONA_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Persona Per"
          },
          "LINKEDIN_URL_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Linkedin Url Per"
          },
          "LINKEDIN_HEADLINE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Linkedin Headline Per"
          },
          "LINKEDIN_INDUSTRY_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Linkedin Industry Per"
          },
          "LINKEDIN_CONNECTIONS_COUNT_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Linkedin Connections Count Per"
          },
          "UPDATED_AT_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Updated At Per"
          },
          "EDUCATION_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Education Per"
          },
          "CERTIFICATIONS_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Certifications Per"
          },
          "LANGUAGES_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Languages Per"
          },
          "SKILLS_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Skills Per"
          },
          "PATENTS_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Patents Per"
          },
          "PUBLICATIONS_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Publications Per"
          },
          "JOB_TITLE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Title Per"
          },
          "JOB_LEVEL_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Level Per"
          },
          "JOB_FUNCTION_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Function Per"
          },
          "JOB_IS_CURRENT_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Is Current Per"
          },
          "JOB_COUNT_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Count Per"
          },
          "JOB_START_DATE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Start Date Per"
          },
          "JOB_DESCRIPTION_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Description Per"
          },
          "LINKEDIN_POSITION_ORDER": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "title": "Linkedin Position Order"
          },
          "JOB_LOCATION_CITY_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Location City Per"
          },
          "JOB_LOCATION_STATE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Location State Per"
          },
          "JOB_LOCATION_COUNTRY_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Location Country Per"
          },
          "JOB_LOCATION_COUNTRY_CODE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Location Country Code Per"
          },
          "JOB_LOCATION_COUNTRY_REGION_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Location Country Region Per"
          },
          "JOB_LOCATION_CONTINENT_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Job Location Continent Per"
          },
          "CITY_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "City Per"
          },
          "STATE_CODE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "State Code Per"
          },
          "STATE_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "State Name Per"
          },
          "COUNTRY_CODE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Country Code Per"
          },
          "COUNTRY_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Country Name Per"
          },
          "COUNTRY_REGION_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Country Region Per"
          },
          "CONTINENT_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Continent Per"
          },
          "LOCATION_POSTCODE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Location Postcode Per"
          },
          "LOCATION_STREET_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Location Street Per"
          },
          "LOCATION_STATE_CODE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Location State Code Per"
          },
          "LOCATION_STATE_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Location State Name Per"
          },
          "LOCATION_COUNTRY_CODE_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Location Country Code Per"
          },
          "LOCATION_COUNTRY_NAME_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Location Country Name Per"
          },
          "LOCATION_COUNTRY_REGION_PER": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Location Country Region Per"
          },
          "COMPANY_NAME_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Company Name Org"
          },
          "COMPANY_NAME_LANGUAGE": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Company Name Language"
          },
          "COMPANY_HEADLINE": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Company Headline"
          },
          "COMPANY_ENTITY_TYPE": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Company Entity Type"
          },
          "COMPANY_LEGAL_TYPE": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Company Legal Type"
          },
          "DOMAIN_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Domain Org"
          },
          "WEBSITE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Website Org"
          },
          "IS_WEBSITE_FOR_SALE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Is Website For Sale Org"
          },
          "PHONE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Phone Org"
          },
          "LOGO_URL_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Logo Url Org"
          },
          "LOGO_URL": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Logo Url"
          },
          "FOUNDED_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Founded Org"
          },
          "SPECIALTIES_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Specialties Org"
          },
          "ABOUT_US_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "About Us Org"
          },
          "LINKEDIN_URL_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Linkedin Url Org"
          },
          "INDUSTRY_LINKEDIN_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Industry Linkedin Org"
          },
          "INDUSTRY_NAICS_CODE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Industry Naics Code Org"
          },
          "INDUSTRY_NAICS_DESCRIPTION_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Industry Naics Description Org"
          },
          "INDUSTRY_SIC_CODE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Industry Sic Code Org"
          },
          "INDUSTRY_SIC_DESCRIPTION_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Industry Sic Description Org"
          },
          "EMPLOYEE_COUNT_MIN": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Employee Count Min"
          },
          "EMPLOYEE_COUNT_MAX": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Employee Count Max"
          },
          "EMPLOYEE_COUNT_RANGE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Employee Count Range Org"
          },
          "EMPLOYEE_PROFILES_ON_LINKEDIN_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Employee Profiles On Linkedin Org"
          },
          "REVENUE_RANGE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Revenue Range Org"
          },
          "REVENUE_MIN": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Revenue Min"
          },
          "REVENUE_MAX": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Revenue Max"
          },
          "HEADQUARTERS_CITY_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Headquarters City Org"
          },
          "HEADQUARTERS_STATE_NAME_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Headquarters State Name Org"
          },
          "HEADQUARTERS_COUNTRY_NAME_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Headquarters Country Name Org"
          },
          "CITY_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "City Org"
          },
          "STATE_CODE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "State Code Org"
          },
          "STATE_NAME_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "State Name Org"
          },
          "POSTCODE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Postcode Org"
          },
          "STREET_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Street Org"
          },
          "COUNTRY_CODE_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Country Code Org"
          },
          "COUNTRY_NAME_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Country Name Org"
          },
          "COUNTRY_REGION_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Country Region Org"
          },
          "LOCATION_CONTINENT_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Location Continent Org"
          },
          "LOCATION_COUNT_ORG": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Location Count Org"
          },
          "REVENUEBASE_CONTACT_VERIFICATION_SUMMARY": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Revenuebase Contact Verification Summary"
          }
        },
        "type": "object",
        "title": "Contact",
        "description": "One position held by the matched person. Field names are the raw\nvelocity_base_unlimited source identifiers. Any field may be null if the\nsource record does not carry it. Extra source fields are silently dropped \u2014\nthe pinned set is defined in DESIGN \u00a71.3."
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "HealthResponse": {
        "properties": {
          "status": {
            "type": "string",
            "title": "Status",
            "default": "ok"
          }
        },
        "type": "object",
        "title": "HealthResponse"
      },
      "RefreshEmailRequest": {
        "properties": {
          "email": {
            "type": "string",
            "maxLength": 320,
            "minLength": 3,
            "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$",
            "title": "Email",
            "examples": [
              "user@example.com"
            ]
          }
        },
        "additionalProperties": false,
        "type": "object",
        "required": [
          "email"
        ],
        "title": "RefreshEmailRequest"
      },
      "RefreshEmailResponse": {
        "properties": {
          "schema_version": {
            "type": "integer",
            "title": "Schema Version",
            "default": 2
          },
          "status": {
            "type": "string",
            "enum": [
              "current",
              "refresh",
              "no_match"
            ],
            "title": "Status"
          },
          "input_email": {
            "type": "string",
            "title": "Input Email"
          },
          "contacts": {
            "items": {
              "$ref": "#/components/schemas/Contact"
            },
            "type": "array",
            "title": "Contacts"
          },
          "request_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Request Id"
          }
        },
        "type": "object",
        "required": [
          "status",
          "input_email"
        ],
        "title": "RefreshEmailResponse",
        "description": "The full response. See README / OpenAPI for field-by-field docs."
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          },
          "input": {
            "title": "Input"
          },
          "ctx": {
            "type": "object",
            "title": "Context"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      }
    },
    "securitySchemes": {
      "APIKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Key"
      }
    }
  }
}