API by router
Pin confirmation internal
POST
instance_id*Instance IdFormat
uuididentity_id*Identity IdFormat
uuidapplication/json- body
Set or change a PIN. Digits only, 4-8 characters.
pin*PinSuccessful Response
application/json- response
PIN status response.
created_at?|nullhas_pin*Has Pinis_active?Is ActiveDefault
falseis_locked?Is LockedDefault
falselocked_until?|nullcurl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/identities/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin' \ -H 'Content-Type: application/json' \ -d '{ "pin": "string"}'Example Response
{ "created_at": "2019-08-24T14:15:22Z", "has_pin": true, "is_active": false, "is_locked": false, "locked_until": "2019-08-24T14:15:22Z"}DELETE
instance_id*Instance IdFormat
uuididentity_id*Identity IdFormat
uuidSuccessful Response
curl -X DELETE 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/identities/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin'Example Response
Empty
GET
instance_id*Instance IdFormat
uuidchannel*ChannelChannel type
external_id*External IdExternal ID to look up
Successful Response
application/json- response
Response for internal identity lookup — mirrors customer_identities.IdentityLookupOut.
channel*Channelcustomer_email?string|nullcustomer_id*Customer IdFormat
uuiddisplay_name?string|nullexternal_id*External Ididentity_id*Identity IdFormat
uuidrole_override?string|nullverified*Verifiedcurl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/lookup/identity?channel=string&external_id=string'Example Response
{ "channel": "string", "customer_email": "string", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "display_name": "string", "external_id": "string", "identity_id": "011a42b9-62d7-49eb-8328-c2e454af88a1", "role_override": "string", "verified": true}POST
instance_id*Instance IdFormat
uuidcustomer_id*Customer IdFormat
uuididentity_id?|nullSuccessful Response
application/json- response
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin/check-required?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{}POST
instance_id*Instance IdFormat
uuidapplication/json- body
Verify a PIN — used by the agent runtime during tool execution.
customer_id?|nullidentity_id?|nullpin*PinSuccessful Response
application/json- response
PIN verification result — returned to the agent runtime.
error?string|nullremaining_attempts?integer|nullsession_token?string|nullsession_ttl_minutes?Session Ttl MinutesDefault
30verified*Verifiedcurl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin/verify' \ -H 'Content-Type: application/json' \ -d '{ "pin": "string"}'Example Response
{ "error": "string", "remaining_attempts": 0, "session_token": "string", "session_ttl_minutes": 30, "verified": true}