FruxonDocs
Agent NetworkParticipants

Sends one of a person's identities a verification.

For a mailbox (`email`, the directory email, or a mail channel's address) the six-digit code is mailed to the address alone and the answer is `PUSH` with no link: the person replies to that mail with the code, and the reply goes to the workspace's email channel, named in `replyTo`. For Telegram and WhatsApp the answer is `PULL` with the link the person opens from that account; for Slack, the code they send the app in a direct message; for the console, `CONSOLE` with the link they open signed in. The link works once, for 15 minutes, and only from the identity it names. Refused with 400 without an address, 400 `address_not_on_person` for an identity the person does not carry, 400 `not_sendable` for an account the person proves by connecting it (GitHub, Jira, GitLab, Linear), 400 `no_reply_mailbox` for a mailbox when the workspace has no email channel to reply to, 409 `identity_held` with the merge suggestion's id (`mergeSuggestionId` beside `message` and `code`) when someone else in the workspace holds it, and 429 `too_many_links` while the person already has three links open (`Retry-After` says when the first expires).

POST
/v1/tenants/{tenant}/participants/{participant}/identityLinks
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

participant*string

The participant identifier.

Formatuuid
tenant*string

The tenant identifier

The identity to verify.

provider?string

The identity's provider: email for the person's directory email, a mail channel's provider for one of its addresses, telegram, a WhatsApp provider, slack, fruxon for the console.

address?string|null

The identity on that provider, exactly as the person carries it. Required whatever the provider: the link is redeemed only from this identity, never from whichever account of the provider happens to open it.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/participants/497f6eca-6276-4993-bfeb-53cbbbba6f08/identityLinks" \  -H "Content-Type: application/json" \  -d '{}'
{
  "requestId": "00000000-0000-0000-0000-000000000000",
  "direction": "PUSH",
  "deepLink": "string",
  "replyTo": "string",
  "expiresAt": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}