Skip to content
General Augment Docs

Link User

POST
/api/v1/integrations/{project_id}/link-user

Create an app-initiated OTP link challenge.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
project_id
required
Project Id
string format: uuid

Header Parameters

Section titled “Header Parameters ”
X-Admin-Key
Any of:
string
X-Admin-API-Key
Any of:
string

Request Body required

Section titled “Request Body required ”
LinkUserRequest

App-initiated linking request payload.

object
metadata
Metadata
object
key
additional properties
any
phone_e164
required
Phone E164
string
>= 7 characters <= 30 characters
provider_name
required
Provider Name
string
>= 1 characters <= 50 characters
provider_user_id
required
Provider User Id
string
>= 1 characters <= 200 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

LinkChallengeResponse

Challenge response returned after a link is initiated.

object
debug_verification_code
Any of:
string
id
required
Id
string format: uuid
magic_link
Any of:
string
phone_e164
required
Phone E164
string
provider_name
required
Provider Name
string
provider_user_id
required
Provider User Id
string
verification_expires_at
required
Verification Expires At
string format: date-time

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string