Heron End Users API is one of 47 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
30 operations
across 23 paths,
and defines 106 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.
FunderSearchResultSchema
object
3 properties
FunderPolicyEvaluation
object
10 properties
SubmitFunderSubmissionResponseSchema
object
1 property
SubmitFunderSubmissionRequestSchema
object
1 property
1 required
DealLinkEntry
object
7 properties
DealLinkOccurrence
object
2 properties
LinkedFunderSubmission
object
3 properties
LitigationEntrySchema
object
6 properties
BackgroundCheckCheckCounts
object
3 properties
3 required
CandidateFieldTrace
object
4 properties
4 required
SearchAttemptCandidateRef
object
6 properties
1 required
EndUserInformationSchema
object
24 properties
BusinessContact
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
12 properties
EndUserSummary
object
19 properties
1 required
BackgroundCheckSection
object
A subject's findings for one record type. Record fields differ by section key.
16 properties
5 required
EndUserWebhookPayload
object
4 properties
DetailMeeting341
object
3 properties
BackgroundCheckSubject
object
14 properties
8 required
DetailDocketEntry
object
16 properties
Address
object
5 properties
BackgroundCheckResolution
object
9 properties
4 required
BackgroundCheckAffiliateReportRequestSchema
object
1 property
1 required
AddressLocation
object
2 properties
BackgroundCheckCheck
object
10 properties
6 required
LienJudgmentRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
30 properties
EndUserInformationPatchSchema
object
23 properties
EndUser
object
14 properties
1 required
SearchAttemptOutcomeReason
object
2 properties
2 required
BackgroundCheckAffiliationReportState
object
3 properties
3 required
CorporateFilingHistoryEntrySchema
object
2 properties
DetailFiling
object
22 properties
ProfilePhone
object
4 properties
UCCFilingEntrySchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
20 properties
CriminalRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
40 properties
BusinessProfileRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
35 properties
BackgroundCheckDecision
object
4 properties
BackgroundCheckOverall
object
3 properties
3 required
BackgroundCheckEvidence
object
4 properties
2 required
CandidateScoreContribution
object
11 properties
5 required
BackgroundCheckAffiliationsViewSchema
object
3 properties
3 required
BackgroundCheckAffiliateConfirmSchema
object
2 properties
2 required
EndUserPostParams
object
13 properties
1 required
BackgroundCheckAffiliationPersonRow
object
8 properties
3 required
DetailCharge
object
35 properties
ProfileSsnIssuance
object
4 properties
BackgroundCheckAffiliateSelection
object
5 properties
4 required
DetailBail
object
5 properties
SearchInputsUsed
object
13 properties
1 required
CriminalChargeEntrySchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
33 properties
CandidateTraceModifier
object
3 properties
2 required
BackgroundCheckOverride
object
3 properties
3 required
CrmSyncEvent
object
8 properties
DetailLienDebtor
object
4 properties
PolicyEvaluationResult
object
4 properties
BackgroundCheckRecordDetail
object
Supplementary source detail returned with includesectiondetail=true. The summarised record is the stable typed interface.
21 properties
BackgroundCheckApplication
object
The application identity used for the search. All fields are nullable; SSNs remain masked.
10 properties
LienJudgmentEntrySchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
25 properties
DataSource
object
2 properties
1 required
DetailCase
object
26 properties
UCCRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
26 properties
ProfileAddress
object
6 properties
EndUserWebhookData
object
3 properties
BackgroundCheckAffiliateRequestAcceptedSchema
object
1 property
1 required
AffiliateSubject
object
14 properties
8 required
CriminalSectionEntrySchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
37 properties
SearchAttemptOutcomeReasonDetail
object
2 properties
1 required
WorkAffiliation
object
5 properties
CriminalSectionRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
50 properties
CandidateAnchorTrace
object
4 properties
2 required
Owner
object
15 properties
CandidateCapTrace
object
3 properties
3 required
BackgroundCheckCandidateOverrideSchema
object
3 properties
SearchAttempt
object
10 properties
7 required
Metric
object
9 properties
BackgroundCheckCandidate
object
One deduplicated candidate across the subject's search attempts, including its match score.
14 properties
1 required
OfacRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
23 properties
BankruptcyRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
13 properties
BackgroundCheckAffiliationRow
object
13 properties
2 required
CandidateScore
object
8 properties
4 required
AssociateRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
17 properties
DuplicateEndUsersResponse
object
1 property
1 required
DetailAttorney
object
8 properties
LawsuitRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
23 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
DetailDefendant
object
5 properties
BackgroundCheckAffiliateSearchInputs
object
6 properties
BackgroundCheckAffiliateReport
object
5 properties
4 required
CrmSyncEventSchema
object
8 properties
EndUserEmailSchema
object
18 properties
TagSchema
object
4 properties
1 required
DetailParty
object
9 properties
ProfileEmail
object
2 properties
MarriageRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
11 properties
EndUserEndUserFile
object
4 properties
CorporateRecordSchema
object
A background-check finding. Risk and severity carry the same none, low, medium, or high tier.
36 properties
EndUserAddressLocationSchema
object
1 property
DetailLabelValue
object
2 properties
1 required
BackgroundCheckRawReportSchema
object
3 properties
3 required
BackgroundCheckNearTie
object
3 properties
2 required
CandidateTraceComponent
object
2 properties
1 required
EndUserProcessingStatusSchema
object
1 property
1 required
BackgroundCheckAffiliationsBlock
object
2 properties
2 required
DuplicateEndUser
object
3 properties
2 required
BusinessContactAddress
object
5 properties
BackgroundCheckPolicy
object
2 properties
2 required
DetailSource
object
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Heron publishes across the network.
