Preview GTM Enrichment
curl --request POST \
--url https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": {
"kind": "person",
"identifiers": {
"email": "[email protected]",
"fullName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"linkedinUrl": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"companyLinkedinUrl": "<string>",
"companyId": "<string>",
"personId": "<string>",
"ipAddress": "<string>"
}
},
"maxCredits": "<string>",
"requestedFields": [],
"objective": "highest_coverage",
"providers": [
"<string>"
],
"contactVerification": "required",
"externalUserId": "<string>",
"attribution": {}
}
'import requests
url = "https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview"
payload = {
"entity": {
"kind": "person",
"identifiers": {
"email": "[email protected]",
"fullName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"linkedinUrl": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"companyLinkedinUrl": "<string>",
"companyId": "<string>",
"personId": "<string>",
"ipAddress": "<string>"
}
},
"maxCredits": "<string>",
"requestedFields": [],
"objective": "highest_coverage",
"providers": ["<string>"],
"contactVerification": "required",
"externalUserId": "<string>",
"attribution": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity: {
kind: 'person',
identifiers: {
email: '[email protected]',
fullName: '<string>',
firstName: '<string>',
lastName: '<string>',
phone: '<string>',
linkedinUrl: '<string>',
companyName: '<string>',
companyDomain: '<string>',
companyLinkedinUrl: '<string>',
companyId: '<string>',
personId: '<string>',
ipAddress: '<string>'
}
},
maxCredits: '<string>',
requestedFields: [],
objective: 'highest_coverage',
providers: ['<string>'],
contactVerification: 'required',
externalUserId: '<string>',
attribution: {}
})
};
fetch('https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entity' => [
'kind' => 'person',
'identifiers' => [
'email' => '[email protected]',
'fullName' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>',
'linkedinUrl' => '<string>',
'companyName' => '<string>',
'companyDomain' => '<string>',
'companyLinkedinUrl' => '<string>',
'companyId' => '<string>',
'personId' => '<string>',
'ipAddress' => '<string>'
]
],
'maxCredits' => '<string>',
'requestedFields' => [
],
'objective' => 'highest_coverage',
'providers' => [
'<string>'
],
'contactVerification' => 'required',
'externalUserId' => '<string>',
'attribution' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview"
payload := strings.NewReader("{\n \"entity\": {\n \"kind\": \"person\",\n \"identifiers\": {\n \"email\": \"[email protected]\",\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDomain\": \"<string>\",\n \"companyLinkedinUrl\": \"<string>\",\n \"companyId\": \"<string>\",\n \"personId\": \"<string>\",\n \"ipAddress\": \"<string>\"\n }\n },\n \"maxCredits\": \"<string>\",\n \"requestedFields\": [],\n \"objective\": \"highest_coverage\",\n \"providers\": [\n \"<string>\"\n ],\n \"contactVerification\": \"required\",\n \"externalUserId\": \"<string>\",\n \"attribution\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": {\n \"kind\": \"person\",\n \"identifiers\": {\n \"email\": \"[email protected]\",\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDomain\": \"<string>\",\n \"companyLinkedinUrl\": \"<string>\",\n \"companyId\": \"<string>\",\n \"personId\": \"<string>\",\n \"ipAddress\": \"<string>\"\n }\n },\n \"maxCredits\": \"<string>\",\n \"requestedFields\": [],\n \"objective\": \"highest_coverage\",\n \"providers\": [\n \"<string>\"\n ],\n \"contactVerification\": \"required\",\n \"externalUserId\": \"<string>\",\n \"attribution\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity\": {\n \"kind\": \"person\",\n \"identifiers\": {\n \"email\": \"[email protected]\",\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDomain\": \"<string>\",\n \"companyLinkedinUrl\": \"<string>\",\n \"companyId\": \"<string>\",\n \"personId\": \"<string>\",\n \"ipAddress\": \"<string>\"\n }\n },\n \"maxCredits\": \"<string>\",\n \"requestedFields\": [],\n \"objective\": \"highest_coverage\",\n \"providers\": [\n \"<string>\"\n ],\n \"contactVerification\": \"required\",\n \"externalUserId\": \"<string>\",\n \"attribution\": {}\n}"
response = http.request(request)
puts response.read_body{}Recipes
Preview GTM Enrichment
Plans enrichment and verification without calling providers or spending credits.
POST
/
wrapped
/
credits
/
locus-gtm
/
enrich
/
preview
Preview GTM Enrichment
curl --request POST \
--url https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": {
"kind": "person",
"identifiers": {
"email": "[email protected]",
"fullName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"linkedinUrl": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"companyLinkedinUrl": "<string>",
"companyId": "<string>",
"personId": "<string>",
"ipAddress": "<string>"
}
},
"maxCredits": "<string>",
"requestedFields": [],
"objective": "highest_coverage",
"providers": [
"<string>"
],
"contactVerification": "required",
"externalUserId": "<string>",
"attribution": {}
}
'import requests
url = "https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview"
payload = {
"entity": {
"kind": "person",
"identifiers": {
"email": "[email protected]",
"fullName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"linkedinUrl": "<string>",
"companyName": "<string>",
"companyDomain": "<string>",
"companyLinkedinUrl": "<string>",
"companyId": "<string>",
"personId": "<string>",
"ipAddress": "<string>"
}
},
"maxCredits": "<string>",
"requestedFields": [],
"objective": "highest_coverage",
"providers": ["<string>"],
"contactVerification": "required",
"externalUserId": "<string>",
"attribution": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity: {
kind: 'person',
identifiers: {
email: '[email protected]',
fullName: '<string>',
firstName: '<string>',
lastName: '<string>',
phone: '<string>',
linkedinUrl: '<string>',
companyName: '<string>',
companyDomain: '<string>',
companyLinkedinUrl: '<string>',
companyId: '<string>',
personId: '<string>',
ipAddress: '<string>'
}
},
maxCredits: '<string>',
requestedFields: [],
objective: 'highest_coverage',
providers: ['<string>'],
contactVerification: 'required',
externalUserId: '<string>',
attribution: {}
})
};
fetch('https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entity' => [
'kind' => 'person',
'identifiers' => [
'email' => '[email protected]',
'fullName' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>',
'linkedinUrl' => '<string>',
'companyName' => '<string>',
'companyDomain' => '<string>',
'companyLinkedinUrl' => '<string>',
'companyId' => '<string>',
'personId' => '<string>',
'ipAddress' => '<string>'
]
],
'maxCredits' => '<string>',
'requestedFields' => [
],
'objective' => 'highest_coverage',
'providers' => [
'<string>'
],
'contactVerification' => 'required',
'externalUserId' => '<string>',
'attribution' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview"
payload := strings.NewReader("{\n \"entity\": {\n \"kind\": \"person\",\n \"identifiers\": {\n \"email\": \"[email protected]\",\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDomain\": \"<string>\",\n \"companyLinkedinUrl\": \"<string>\",\n \"companyId\": \"<string>\",\n \"personId\": \"<string>\",\n \"ipAddress\": \"<string>\"\n }\n },\n \"maxCredits\": \"<string>\",\n \"requestedFields\": [],\n \"objective\": \"highest_coverage\",\n \"providers\": [\n \"<string>\"\n ],\n \"contactVerification\": \"required\",\n \"externalUserId\": \"<string>\",\n \"attribution\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": {\n \"kind\": \"person\",\n \"identifiers\": {\n \"email\": \"[email protected]\",\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDomain\": \"<string>\",\n \"companyLinkedinUrl\": \"<string>\",\n \"companyId\": \"<string>\",\n \"personId\": \"<string>\",\n \"ipAddress\": \"<string>\"\n }\n },\n \"maxCredits\": \"<string>\",\n \"requestedFields\": [],\n \"objective\": \"highest_coverage\",\n \"providers\": [\n \"<string>\"\n ],\n \"contactVerification\": \"required\",\n \"externalUserId\": \"<string>\",\n \"attribution\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/wrapped/credits/locus-gtm/enrich/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity\": {\n \"kind\": \"person\",\n \"identifiers\": {\n \"email\": \"[email protected]\",\n \"fullName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"companyName\": \"<string>\",\n \"companyDomain\": \"<string>\",\n \"companyLinkedinUrl\": \"<string>\",\n \"companyId\": \"<string>\",\n \"personId\": \"<string>\",\n \"ipAddress\": \"<string>\"\n }\n },\n \"maxCredits\": \"<string>\",\n \"requestedFields\": [],\n \"objective\": \"highest_coverage\",\n \"providers\": [\n \"<string>\"\n ],\n \"contactVerification\": \"required\",\n \"externalUserId\": \"<string>\",\n \"attribution\": {}\n}"
response = http.request(request)
puts response.read_body{}Authorizations
secretKeyendUserTokenagentConnection
Tenant secret key (lcr_…). Server-side only.
Headers
Required only when the end-user JWT carries sid. Send the original high-entropy session value; sid is its SHA-256 fingerprint. Ignored for secret-key authentication.
Required string length:
16 - 128Pattern:
^[A-Za-z0-9][A-Za-z0-9._:-]{15,127}$Body
application/json
- Option 1
- Option 2
Show child attributes
Show child attributes
Aggregate provider-and-verification ceiling in workspace credits. Required for direct and hosted Workflow execution; set it equal to the Workflow call maxChargeCredits unless the Workflow call intentionally allows a tighter cap.
Pattern:
^\d+(?:\.\d{1,6})?$Available options:
person.fullName, person.firstName, person.lastName, person.jobTitle, person.location, person.linkedinUrl, person.workEmail, person.personalEmail, person.mobilePhone, company.name, company.domain, company.website, company.linkedinUrl, company.description, company.industry, company.employeeCount, company.employeeRange, company.revenueRange, company.headquarters, company.phone, company.technologies, company.funding, company.hiring Available options:
person_core, person_contact, company_core, company_intelligence, full Available options:
highest_coverage Require deliverability checks for discovered emails and validity, reachability, and available ownership evidence for discovered phones.
Available options:
required, none Response
Enrichment plan and estimate
The response is of type object.