How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Immutable passport profile API

Passport Profile endpoints

Immutable passport profile API is one of 17 APIs that Immutable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include passport profile. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 6 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.sandbox.immutable.com.

6 operations 6 paths 21 schemas 2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.immutable.com
Authentication
HTTP Bearer, HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Immutable passport profile API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuthWithClient). It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as x-immutable-api-key (ImmutableApiKey). It accepts HTTP bearer tokens (JWT) (OktaBearerAuth).

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 2 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

passport profile 6

Passport Profile endpoints

POST
/passport-profile/v1/phone-otp/verify
Verify phone OTP code against user phone number
verify-phone-otp body → 200400429500
GET
/passport-profile/v1/profile
Get profile for authenticated user
get-profile-by-authenticated-wallet → 200401429500
POST
/passport-profile/v1/username
Update username
update-username body → 200400401403500
POST
/passport-profile/v1/phone-otp
Send phone OTP code for user supplied phone number
send-phone-otp body → 200400401403429500
POST
/passport-profile/v2/linked-wallets
Link wallet v2
link-wallet-v2 body → 200400401403500
GET
/passport-profile/v1/user/info
Get all info for a Passport user
getUserInfo → 200401500default

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Wallet (6 properties), LinkWalletV2Request (4 properties), UserInfo (4 properties), BasicAPIError (3 properties). Each schema is shown below with its type and property counts.

PhoneNumber
string
Phone number
PhoneNumberOTPVerificationRequest
object
Phone number OTP verification request
2 properties 2 required
PhoneNumberOTP
string
Phone number verification OTP
CreatedAt
string
Created at
APIError403
APIError400
APIError429
UsernameUpdateResponse
object
Username update response
1 property 1 required
PhoneNumberOTPResponse
object
Phone number OTP request
1 property 1 required
Wallet
object
Linked wallet
6 properties 5 required
LinkWalletV2Request
object
Link wallet V2 request
4 properties 4 required
APIError500
Name
string
Name
UsernameUpdateRequest
object
Request to update username
1 property 1 required
UserInfo
object
4 properties 2 required
EthAddress
string
Ethereum address
BasicAPIError
object
3 properties 3 required
PhoneNumberOTPRequest
object
Phone number OTP request
2 properties 1 required
ProfileResponse
object
Get profile by wallet response
1 property 1 required
APIError401
WalletType
string
Wallet type

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

immutable-passport-profile-api-openapi.yml Raw ↑

Other APIs Immutable publishes across the network.

Immutable Passport Authentication
Immutable Activities API
Immutable Chains API
Immutable Collections API
Immutable Crafting API
Immutable Data API
Immutable Ingest API
Immutable Metadata API
Immutable Metadata Search API
Immutable nft owners API
Immutable Nfts API
Immutable Orders API
Where this information came from

This is an independent, third-party profile of Immutable passport profile API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.