> ## Documentation Index
> Fetch the complete documentation index at: https://docs.borderless.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Look up a Crypto Credential alias

> Resolves an alias across the Crypto Credential network and returns its status, the country it is registered in, and the assets it can receive. The alias may belong to any participant, which makes this the check to run before sending funds to one. vasps is present only when your organization is entitled to that data.



## OpenAPI

````yaml https://sandbox-api.borderless.xyz/v1/api-json get /v1/mastercard/crypto-credential/alias-lookup
openapi: 3.0.0
info:
  title: Borderless API
  description: The Borderless API documentation.
  version: '1.0'
  contact: {}
servers:
  - url: https://sandbox-api.borderless.xyz
security: []
tags: []
paths:
  /v1/mastercard/crypto-credential/alias-lookup:
    get:
      tags:
        - Mastercard Crypto Credential
      summary: Look up a Crypto Credential alias
      description: >-
        Resolves an alias across the Crypto Credential network and returns its
        status, the country it is registered in, and the assets it can receive.
        The alias may belong to any participant, which makes this the check to
        run before sending funds to one. vasps is present only when your
        organization is entitled to that data.
      operationId: CryptoCredentialController_aliasLookup
      parameters:
        - name: accountAlias
          required: true
          in: query
          description: >-
            The alias to resolve. It may belong to any organisation on the
            Crypto Credential network, not only your own.
          schema:
            maxLength: 255
            example: user@example.com
            type: string
        - name: asset
          required: false
          in: query
          description: >-
            Restrict the results to a single token tied to a specific
            blockchain. Omit it to receive every asset the alias supports.
          schema:
            $ref: '#/components/schemas/AssetId'
        - name: offset
          required: false
          in: query
          description: How many of the alias's assets to skip before returning results.
          schema:
            minimum: 0
            default: 0
            type: number
        - name: limit
          required: false
          in: query
          description: Maximum number of the alias's assets to return in one response.
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
      responses:
        '200':
          description: Alias lookup results returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoCredentialEntity'
      security:
        - bearer: []
components:
  schemas:
    AssetId:
      type: string
      enum:
        - POL
        - USDT_POLYGON
        - USDC_POLYGON
        - SBC_POLYGON
        - ETH
        - USDT_ETHEREUM
        - USDC_ETHEREUM
        - PYUSD_ETHEREUM
        - DAI_ETHEREUM
        - EURC_ETHEREUM
        - SBC_ETHEREUM
        - TRX
        - USDT_TRON
        - SBC_TRON
        - ETH_BASE
        - USDC_BASE
        - USDB_BASE
        - EURC_BASE
        - SBC_BASE
        - ETH_OPTIMISM
        - USDT_OPTIMISM
        - USDC_OPTIMISM
        - BTC
        - CELO
        - CUSD_CELO
        - USDC_CELO
        - SBC_CELO
        - SOL
        - USDC_SOLANA
        - USDT_SOLANA
        - PYUSD_SOLANA
        - USDP_SOLANA
        - EURC_SOLANA
        - SBC_SOLANA
    CryptoCredentialEntity:
      type: object
      properties:
        aliases:
          nullable: true
          description: >-
            The aliases this credential is known by. Absent only when the
            credential could not be created.
          type: object
          allOf:
            - $ref: '#/components/schemas/CryptoCredentialAliasesEntity'
        status:
          nullable: true
          description: >-
            The status of the alias. Only an active alias should be treated as
            safe to send funds to. Absent when the alias could not be resolved.
          allOf:
            - $ref: '#/components/schemas/CryptoCredentialAccountStatus'
        country:
          nullable: true
          description: >-
            The country the alias is registered in, in ISO-3166-2 format. See
            [ISO-3166-2
            documentation](https://www.iso.org/iso-3166-country-codes.html).
          allOf:
            - $ref: '#/components/schemas/CountryCode'
        vasps:
          nullable: true
          description: >-
            Virtual asset service providers that can route funds to the alias.
            Present only when your organization is entitled to VASP data.
          type: array
          items:
            type: string
        assets:
          description: >-
            The assets this alias can receive, narrowed by the asset filter when
            one is sent. Empty when it can receive none.
          type: array
          items:
            $ref: '#/components/schemas/CryptoCredentialAssetEntity'
        errors:
          nullable: true
          description: >-
            Why the credential could not be created or resolved. Present only
            when something went wrong; the credential data above is then absent.
          type: array
          items:
            $ref: '#/components/schemas/CryptoCredentialErrorEntity'
      required:
        - assets
    CryptoCredentialAliasesEntity:
      type: object
      properties:
        email:
          type: string
          description: >-
            The email the account was registered under. Frozen at creation —
            changing the identity's email does not change it.
        domainName:
          type: string
          nullable: true
          description: >-
            The domain name alias Mastercard derived on creation. This is what
            other participants resolve. Absent when Mastercard returned none.
      required:
        - email
    CryptoCredentialAccountStatus:
      type: string
      enum:
        - Active
        - Suspended
        - Decommissioned
      description: >-
        The status of the alias. Only an active alias should be treated as safe
        to send funds to. Absent when the alias could not be resolved.
    CountryCode:
      type: string
      enum:
        - AF
        - AL
        - DZ
        - AS
        - AD
        - AO
        - AI
        - AQ
        - AG
        - AR
        - AM
        - AW
        - AU
        - AT
        - AZ
        - BS
        - BH
        - BD
        - BB
        - BY
        - BE
        - BZ
        - BJ
        - BM
        - BT
        - BO
        - BQ
        - BA
        - BW
        - BV
        - BR
        - IO
        - BN
        - BG
        - BF
        - BI
        - CV
        - KH
        - CM
        - CA
        - KY
        - CF
        - TD
        - CL
        - CN
        - CX
        - CC
        - CO
        - KM
        - CD
        - CG
        - CK
        - CR
        - HR
        - CU
        - CW
        - CY
        - CZ
        - CI
        - DK
        - DJ
        - DM
        - DO
        - EC
        - EG
        - SV
        - GQ
        - ER
        - EE
        - SZ
        - ET
        - FK
        - FO
        - FJ
        - FI
        - FR
        - GF
        - PF
        - TF
        - GA
        - GM
        - GE
        - DE
        - GH
        - GI
        - GR
        - GL
        - GD
        - GP
        - GU
        - GT
        - GG
        - GN
        - GW
        - GY
        - HT
        - HM
        - VA
        - HN
        - HK
        - HU
        - IS
        - IN
        - ID
        - IR
        - IQ
        - IE
        - IM
        - IL
        - IT
        - JM
        - JP
        - JE
        - JO
        - KZ
        - KE
        - KI
        - KP
        - KR
        - KW
        - KG
        - LA
        - LV
        - LB
        - LS
        - LR
        - LY
        - LI
        - LT
        - LU
        - MO
        - MG
        - MW
        - MY
        - MV
        - ML
        - MT
        - MH
        - MQ
        - MR
        - MU
        - YT
        - MX
        - FM
        - MD
        - MC
        - MN
        - ME
        - MS
        - MA
        - MZ
        - MM
        - NA
        - NR
        - NP
        - NL
        - NC
        - NZ
        - NI
        - NE
        - NG
        - NU
        - NF
        - MP
        - 'NO'
        - OM
        - PK
        - PW
        - PS
        - PA
        - PG
        - PY
        - PE
        - PH
        - PN
        - PL
        - PT
        - PR
        - QA
        - MK
        - RO
        - RU
        - RW
        - RE
        - BL
        - SH
        - KN
        - LC
        - MF
        - PM
        - VC
        - WS
        - SM
        - ST
        - SA
        - SN
        - RS
        - SC
        - SL
        - SG
        - SX
        - SK
        - SI
        - SB
        - SO
        - ZA
        - GS
        - SS
        - ES
        - LK
        - SD
        - SR
        - SJ
        - SE
        - CH
        - SY
        - TW
        - TJ
        - TZ
        - TH
        - TL
        - TG
        - TK
        - TO
        - TT
        - TN
        - TR
        - TM
        - TC
        - TV
        - UG
        - UA
        - AE
        - GB
        - UM
        - US
        - UY
        - UZ
        - VU
        - VE
        - VN
        - VG
        - VI
        - WF
        - EH
        - YE
        - ZM
        - ZW
        - AX
        - ZZ
    CryptoCredentialAssetEntity:
      type: object
      properties:
        asset:
          nullable: true
          description: A token tied to a specific blockchain that this alias can receive.
          allOf:
            - $ref: '#/components/schemas/AssetId'
        vasps:
          nullable: true
          description: >-
            Virtual asset service providers that can route this asset to the
            alias. Present only when your organization is entitled to VASP data.
          type: array
          items:
            type: string
    CryptoCredentialErrorEntity:
      type: object
      properties:
        reasonCode:
          type: string
          nullable: true
          description: The reason code Mastercard returned, passed through unchanged.
        message:
          type: string
          description: Human readable explanation of what went wrong.
      required:
        - message
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````