Heron End Users API is one of 48 APIs that Heron publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include End Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.
This API exposes
27 operations
across 20 paths,
and defines 99 schemas.
It is described by OpenAPI 3.2.0, at version 2021-07-19.
Requests are made against a single base URL, https://app.herondata.io.
The identity and technical contract details declared by the specification.
BackgroundCheckSubject
object
14 properties
8 required
BusinessContact
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
12 properties
BackgroundCheckCheck
object
10 properties
6 required
BackgroundCheckResolution
object
9 properties
4 required
BackgroundCheckRecordDetail
object
Supplementary source detail returned with includesectiondetail=true. The summarised record is the stable typed interface.
21 properties
EndUserEndUserFile
object
4 properties
BusinessProfileRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
35 properties
BackgroundCheckAffiliateRequestAcceptedSchema
object
1 property
1 required
EndUserSummary
object
19 properties
1 required
BackgroundCheckAffiliateSelection
object
5 properties
4 required
AddressLocation
object
2 properties
CrmSyncEvent
object
8 properties
BackgroundCheckEvidence
object
4 properties
2 required
ProfileSsnIssuance
object
4 properties
LawsuitRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
23 properties
BackgroundCheckAffiliateReportRequestSchema
object
1 property
1 required
TagSchema
object
4 properties
1 required
DetailLienDebtor
object
4 properties
BackgroundCheckCandidate
object
One deduplicated candidate across the subject's search attempts, including its match score.
14 properties
1 required
EndUserWebhookData
object
3 properties
CorporateRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
36 properties
LienJudgmentRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
30 properties
DetailMeeting341
object
3 properties
EndUserInformationSchema
object
24 properties
EndUserProcessingStatusSchema
object
1 property
1 required
BackgroundCheckAffiliateConfirmSchema
object
2 properties
2 required
CandidateScore
object
8 properties
4 required
SearchAttemptCandidateRef
object
6 properties
1 required
LienJudgmentEntrySchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
25 properties
CriminalSectionRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
50 properties
BackgroundCheckSection
object
A subject's findings for one record type. Record fields differ by section key.
16 properties
5 required
DuplicateEndUsersResponse
object
1 property
1 required
DetailDocketEntry
object
16 properties
UCCRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
26 properties
EndUserInformationPatchSchema
object
23 properties
SearchAttempt
object
10 properties
7 required
BackgroundCheckOverall
object
3 properties
3 required
DetailBail
object
5 properties
ProfilePhone
object
4 properties
BackgroundCheckAffiliateSearchInputs
object
6 properties
BackgroundCheckNearTie
object
3 properties
2 required
LitigationEntrySchema
object
6 properties
BusinessContactAddress
object
5 properties
BackgroundCheckResponseSchema
object
Dates use YYYY-MM-DD. Amounts are decimal strings. Nullable source fields return null. SSNs remain masked; full SSNs never appear.
7 properties
3 required
OfacRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
23 properties
DetailLabelValue
object
2 properties
1 required
EndUserEmailSchema
object
18 properties
EndUserWebhookPayload
object
4 properties
EndUserPostParams
object
13 properties
1 required
DetailDefendant
object
5 properties
BackgroundCheckAffiliateReport
object
5 properties
4 required
UCCFilingEntrySchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
20 properties
SearchInputsUsed
object
13 properties
1 required
BackgroundCheckAffiliationsViewSchema
object
3 properties
3 required
BackgroundCheckAffiliationPersonRow
object
8 properties
3 required
SearchAttemptOutcomeReasonDetail
object
2 properties
1 required
SearchAttemptOutcomeReason
object
2 properties
2 required
PolicyEvaluationResult
object
4 properties
BackgroundCheckCheckCounts
object
3 properties
3 required
CandidateTraceModifier
object
3 properties
2 required
DuplicateEndUser
object
3 properties
2 required
AffiliateSubject
object
14 properties
8 required
BackgroundCheckCandidateOverrideSchema
object
3 properties
CandidateScoreContribution
object
11 properties
5 required
CandidateFieldTrace
object
4 properties
4 required
CorporateFilingHistoryEntrySchema
object
2 properties
CriminalChargeEntrySchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
33 properties
ProfileAddress
object
6 properties
DetailFiling
object
22 properties
MarriageRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
11 properties
CrmSyncEventSchema
object
8 properties
DetailCase
object
26 properties
CandidateCapTrace
object
3 properties
3 required
DetailCharge
object
35 properties
EndUser
object
14 properties
1 required
BackgroundCheckOverride
object
3 properties
3 required
CandidateAnchorTrace
object
4 properties
2 required
BackgroundCheckRawReportSchema
object
3 properties
3 required
DataSource
object
2 properties
1 required
EndUserAddressLocationSchema
object
1 property
DetailAttorney
object
8 properties
BankruptcyRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
13 properties
ProfileEmail
object
2 properties
CriminalRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
40 properties
Owner
object
15 properties
WorkAffiliation
object
5 properties
Address
object
5 properties
BackgroundCheckAffiliationRow
object
13 properties
2 required
BackgroundCheckDecision
object
4 properties
AssociateRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
17 properties
DetailSource
object
4 properties
Metric
object
9 properties
CriminalSectionEntrySchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
37 properties
CandidateTraceComponent
object
2 properties
1 required
BackgroundCheckAffiliationsBlock
object
2 properties
2 required
BackgroundCheckPolicy
object
2 properties
2 required
BackgroundCheckAffiliationReportState
object
3 properties
3 required
BackgroundCheckApplication
object
The application identity used for the search. All fields are nullable; SSNs remain masked.
10 properties
DetailParty
object
9 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Heron publishes across the network.
