Skip to main content
GET
Get a prospect.

Authorizations

Authorization
string
header
required

OAuth 2.0 client_credentials grant via Keycloak service account. Clients are provisioned per IntegrationOrganization in the nt24-idp realm.

Path Parameters

sellerId
string<uuid>
required

UUID of the seller trade partner (must be in caller's authorized list).

uuid
string<uuid>
required

Response

OK

A prospect of the seller, from every entry channel: the seller's company link (its company number), a contact's personal link or a campaign link.

uuid
string<uuid>
required
type
enum<string>
required

Whether the party is a legal entity or a natural person. Shared by BuyerResponse and ProspectResponse, which describe the same two kinds of party at different points of the onboarding flow.

The webhook contract publishes these same two values as ProspectType in asyncapi-integration-v1.yaml. Two names, one set of values.

Available options:
COMPANY,
CONSUMER
status
enum<string>
required
Available options:
PENDING,
CONFIRMED,
REJECTED
submittedAt
string<date-time>
required
source
enum<string>
required

Always present.

Available options:
CLICK2COMPLY,
PROSPECT_LINK
companyName
string
firstName
string
lastName
string
email
string<email>
buyerId
string<uuid>

Uuid of the buyer this prospect was converted into. Present once the prospect is CONFIRMED; absent while it is PENDING or REJECTED.

The personal or campaign link the prospect came through. Absent for the seller's company link and for prospects from before links were recorded.

creditedContact
object

The seller's contact the prospect is credited to. Absent when it is credited to the seller company. The seller's members can change it on the platform, so it can differ from the link's credited contact.