Skip to main content
POST
Match Profile
Caching Available: Use the optional cacheDuration parameter to enable caching and reduce costs. Cache hits consume only 1 credit instead of 2 credits. See the request parameters below for details.

How Caching Works

Cache Hit

If we find the profile in our cache within your specified duration, we serve it instantly at 1 credit. This is a 50% savings on the standard price.

Cache Miss

If the profile isn’t cached, we perform a live scrape to get fresh data. This costs the standard 2 credits.
Complete History: The positionHistory, educationHistory, and certificationHistory fields return all positions, education entries, and certifications available on the profile.

Request Tracking & Reporting

Found incorrect or missing data? Visit your API Logs to view all requests and report issues directly from the web interface.
How to report an issue:
  1. Go to app.scrapin.io/api-logs
  2. Find the request you want to report in the logs table
  3. Click the “Report” button in the Actions column
  4. Select the issue type and add a description
The request_id helps our team investigate and resolve issues quickly. All enrichment requests are automatically logged for your convenience.

Authorizations

apikey
string
query
required

This required parameter is a string. It represents the APIKEY obtained from the developer dashboard. You must use it in the query string of your request as ?apikey=YOUR_API_KEY or in the headers as x-api-key: YOUR_API_KEY

Body

application/json
includes
object
required

This required parameter is an object. It specifies which additional data to include in the response.

firstName
string

This optional parameter is a string. It represents the first name to body.

lastName
string

This optional parameter is a string. It represents the last name to body.

companyDomain
string

This optional parameter is a string. It represents the company domain/URL to body. *You can use current or any previous company to that person.

companyName
string

This optional parameter is a string. It represents the company name to body. *You can use current or any previous company to that person.

email
string

This optional parameter is a string. It represents the email to body.

cacheDuration
string

Optional parameter to enable caching. Accepts duration strings like '4h', '2d', '1w', '2mo', '1y'. We use the parse-duration library internally to parse these values. If the profile is found in cache within this duration, only 1 credit is consumed. Otherwise, fresh data is scraped for 2 credits.

Example:

"2d"

Response

The endpoint returns profile information.

success
boolean

Indicates success or failure of api request.

credits_consumed
number

Represents the number of credits consumed by this query.

credits_left
number

Represents the usable credits available for the user account after this query.

rate_limit_left
number

Represents the usable daily request limit available for the user account after this query.

daily_rate_limit_left
number

Represents the usable daily request limit available for the user account after this query.

minute_rate_limit_left
number

Represents the usable minute request limit available for the user account after this query.

next_minute_rate_limit_reset
string

Represents the next minute rate limit reset for the user account after this query. Datetime in ISO 8601 format (e.g., 2025-11-14T14:34:43.000Z).

quotas
object

Structured quota information for the user account. Provides the same data as the flat fields above in a more organized format.

person
object
company
metadata
object