Alias

POST/api/v1/alias/link

Link_alias

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

display_name?|

Optional display name

external_id*string

Raw external id on the platform

handle?|

Optional human-facing handle

identity_kind?null|

metadata?unknown

Optional metadata payload

platform*string

External platform identifier such as discord, wallet, domain, email

scopes?array<string>

Scopes granted for resolution through this alias

user_id?|

Target user id (defaults to the caller when omitted)

verification?null|

visibility?null|

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/alias/link" \  -H "Content-Type: application/json" \  -d '{    "external_id": "string",    "platform": "string"  }'

{  "alias_id": "string",  "normalized_id": "string",  "user_id": "string",  "verification_status": "pending_verification"}

POST/api/v1/alias/merge

Create_merge

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

alias_ids_to_move?array<string>

Alias ids to move from source to target

conflict_policy?null|

evidence?unknown

Evidence payload

reason*string

Reason for the merge

source_user_id*string

Source user id (the duplicate)

target_user_id*string

Target user id (the survivor)

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/alias/merge" \  -H "Content-Type: application/json" \  -d '{    "reason": "string",    "source_user_id": "string",    "target_user_id": "string"  }'

{  "alias_ids_to_move": [    "string"  ],  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "merge_id": "string",  "moved_alias_ids": [    "string"  ],  "source_user_id": "string",  "status": "draft",  "target_user_id": "string"}

POST/api/v1/alias/merge/{merge_id}/approve

Approve_merge

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

merge_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/alias/merge/string/approve"

{  "alias_ids_to_move": [    "string"  ],  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "merge_id": "string",  "moved_alias_ids": [    "string"  ],  "source_user_id": "string",  "status": "draft",  "target_user_id": "string"}

POST/api/v1/alias/merge/{merge_id}/reject

Reject_merge

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

merge_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?|

Reason for rejecting the merge

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/alias/merge/string/reject" \  -H "Content-Type: application/json" \  -d '{}'

{  "alias_ids_to_move": [    "string"  ],  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "merge_id": "string",  "moved_alias_ids": [    "string"  ],  "source_user_id": "string",  "status": "draft",  "target_user_id": "string"}

GET/api/v1/alias/metadata/{user_id}

Aggregate_metadata

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

user_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/alias/metadata/string"

{  "fields": {    "property1": {      "platform": "string",      "source_alias_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "value": null    },    "property2": {      "platform": "string",      "source_alias_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "value": null    }  },  "user_id": "string"}

POST/api/v1/alias/proxies

Create_proxy

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

audience*string

Audience scope such as world:forest-01

expires_in_seconds?|

Lifetime of the proxy in seconds

Formatint64

Range0 <= value

link_visibility?null|

public_metadata?unknown

Public metadata exposed to ordinary callers

purpose*string

Purpose of the proxy

scope?array<string>

Scopes granted to the proxy

user_id?|

User the proxy represents (defaults to caller)

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/alias/proxies" \  -H "Content-Type: application/json" \  -d '{    "audience": "string",    "purpose": "string"  }'

{  "audience": "string",  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "link_visibility": "restricted",  "proxy_handle": "string",  "proxy_id": "string",  "public_metadata": null,  "purpose": "string",  "scope": [    "string"  ],  "status": "active",  "user_id": "string"}

POST/api/v1/alias/recovery-contacts

Add_recovery_contact

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contact*string

Raw contact value; only a salted hash is persisted

contact_kind?RecoveryContactKind

Contact kind

Value in

"email"
"phone"
"wallet"
"custom"

scopes?array<string>

Scopes for the recovery contact mapping

user_id?|

User owning the recovery contact (defaults to caller)

verified?boolean

Whether the contact is already verified

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/alias/recovery-contacts" \  -H "Content-Type: application/json" \  -d '{    "contact": "string"  }'

{  "contact_hash": "string",  "contact_kind": "email",  "created_at": "2019-08-24T14:15:22Z",  "last_verified_at": "2019-08-24T14:15:22Z",  "recovery_id": "string",  "scopes": [    "string"  ],  "user_id": "string",  "verification_status": "pending"}

POST/api/v1/alias/recovery-contacts/verify

Verify_recovery_contact

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

contact*string

Raw contact value; matched against the stored salted hash

recovery_id*string

Recovery contact mapping id to verify

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/alias/recovery-contacts/verify" \  -H "Content-Type: application/json" \  -d '{    "contact": "string",    "recovery_id": "string"  }'

{  "contact_hash": "string",  "contact_kind": "email",  "created_at": "2019-08-24T14:15:22Z",  "last_verified_at": "2019-08-24T14:15:22Z",  "recovery_id": "string",  "scopes": [    "string"  ],  "user_id": "string",  "verification_status": "pending"}

GET/api/v1/alias/resolve/{id}

Resolve_alias

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

platform?string

Platform hint when the id is ambiguous

scope?string

Requested scope for shaped resolution output

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/alias/resolve/string"

{  "alias_id": "string",  "is_primary": true,  "platform": "string",  "user_id": "string",  "verification_status": "pending_verification",  "visible_metadata": null}

GET/api/v1/alias/users/{user_id}/aliases

List_user_aliases

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

user_id*string

Query Parameters

status?string

Filter by verification status

platform?string

Filter by platform

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/alias/users/string/aliases"

{  "aliases": [    {      "alias_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "display_name": "string",      "external_id": "string",      "handle": "string",      "identity_kind": "platform_account",      "is_primary": true,      "linked_at": "2019-08-24T14:15:22Z",      "metadata": null,      "normalized_id": "string",      "platform": "string",      "revocation_reason": "string",      "revoked_at": "2019-08-24T14:15:22Z",      "scopes": [        "string"      ],      "updated_at": "2019-08-24T14:15:22Z",      "user_id": "string",      "verification_attestations": [        {          "attestation_id": "string",          "confidence": 0.1,          "expires_at": "2019-08-24T14:15:22Z",          "issued_at": "2019-08-24T14:15:22Z",          "issuer": "string",          "method": "social_proof",          "proof": null,          "revoked_at": "2019-08-24T14:15:22Z",          "status": "valid"        }      ],      "verification_status": "pending_verification",      "verified_at": "2019-08-24T14:15:22Z",      "visibility": "public"    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

GET/api/v1/alias/users/{user_id}/recovery-contacts

List_recovery_contacts

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

user_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/alias/users/string/recovery-contacts"

{  "recovery_contacts": [    {      "contact_hash": "string",      "contact_kind": "email",      "created_at": "2019-08-24T14:15:22Z",      "last_verified_at": "2019-08-24T14:15:22Z",      "recovery_id": "string",      "scopes": [        "string"      ],      "user_id": "string",      "verification_status": "pending"    }  ],  "user_id": "string"}

GET/api/v1/alias/{alias_id}

Get_alias

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

alias_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/alias/string"

{  "alias_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "display_name": "string",  "external_id": "string",  "handle": "string",  "identity_kind": "platform_account",  "is_primary": true,  "linked_at": "2019-08-24T14:15:22Z",  "metadata": null,  "normalized_id": "string",  "platform": "string",  "revocation_reason": "string",  "revoked_at": "2019-08-24T14:15:22Z",  "scopes": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z",  "user_id": "string",  "verification_attestations": [    {      "attestation_id": "string",      "confidence": 0.1,      "expires_at": "2019-08-24T14:15:22Z",      "issued_at": "2019-08-24T14:15:22Z",      "issuer": "string",      "method": "social_proof",      "proof": null,      "revoked_at": "2019-08-24T14:15:22Z",      "status": "valid"    }  ],  "verification_status": "pending_verification",  "verified_at": "2019-08-24T14:15:22Z",  "visibility": "public"}

DELETE/api/v1/alias/{alias_id}

Revoke_alias

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

alias_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?|

Reason for revocation

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/alias/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "alias_id": "string",  "message": "string"}

POST/api/v1/alias/{alias_id}/attestations

Add_attestation

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

alias_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

confidence?|

Confidence in range 0.0..=1.0

Formatdouble

expires_in_seconds?|

Optional expiry in seconds from now

Formatint64

Range0 <= value

issuer*string

Issuer label

method*VerificationMethod

Verification method

Value in

"social_proof"
"domain_verification"
"recovery_challenge"
"admin_review"
"platform_callback"

proof?unknown

Proof payload

revoke?boolean

Whether this attestation marks the alias as revoked evidence

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/alias/string/attestations" \  -H "Content-Type: application/json" \  -d '{    "issuer": "string",    "method": "social_proof"  }'

{  "alias_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "display_name": "string",  "external_id": "string",  "handle": "string",  "identity_kind": "platform_account",  "is_primary": true,  "linked_at": "2019-08-24T14:15:22Z",  "metadata": null,  "normalized_id": "string",  "platform": "string",  "revocation_reason": "string",  "revoked_at": "2019-08-24T14:15:22Z",  "scopes": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z",  "user_id": "string",  "verification_attestations": [    {      "attestation_id": "string",      "confidence": 0.1,      "expires_at": "2019-08-24T14:15:22Z",      "issued_at": "2019-08-24T14:15:22Z",      "issuer": "string",      "method": "social_proof",      "proof": null,      "revoked_at": "2019-08-24T14:15:22Z",      "status": "valid"    }  ],  "verification_status": "pending_verification",  "verified_at": "2019-08-24T14:15:22Z",  "visibility": "public"}

PATCH/api/v1/alias/{alias_id}/primary

Set_primary

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

alias_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

scope?|

Display scope this primary applies to (defaults to whole user)

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/alias/string/primary" \  -H "Content-Type: application/json" \  -d '{}'

{  "alias_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "display_name": "string",  "external_id": "string",  "handle": "string",  "identity_kind": "platform_account",  "is_primary": true,  "linked_at": "2019-08-24T14:15:22Z",  "metadata": null,  "normalized_id": "string",  "platform": "string",  "revocation_reason": "string",  "revoked_at": "2019-08-24T14:15:22Z",  "scopes": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z",  "user_id": "string",  "verification_attestations": [    {      "attestation_id": "string",      "confidence": 0.1,      "expires_at": "2019-08-24T14:15:22Z",      "issued_at": "2019-08-24T14:15:22Z",      "issuer": "string",      "method": "social_proof",      "proof": null,      "revoked_at": "2019-08-24T14:15:22Z",      "status": "valid"    }  ],  "verification_status": "pending_verification",  "verified_at": "2019-08-24T14:15:22Z",  "visibility": "public"}

Alias

201application/json

400

409

503

201application/json

400

503

200application/json

403

404

409

503

200application/json

403

404

409

503

200application/json

403

503

201application/json

400

503

201application/json

403

503

200application/json

400

403

404

503

200application/json

403

404

503

200application/json

503

200application/json

403

503

200application/json

403

404

503

200application/json

403

404

503

200application/json

403

404

503

200application/json

403

404

503

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`