> ## Documentation Index > Fetch the complete documentation index at: https://docs.hifi.com/llms.txt > Use this file to discover all available pages before exploring further. # Map v2 IDs to v3 IDs > Resolve up to 1000 v2 resource UUIDs to their corresponding v3 public IDs. Entries that cannot be resolved (unknown ID, or a `resourceType` without a migration mapping) are returned with `v3Id: null` and `mapped: false` rather than causing the whole request to fail. This is a `GET` request with a JSON request body; ensure your HTTP client and any intermediate proxies are configured to send a body with `GET`. ## OpenAPI ````yaml https://production.hifi.com/api/v3/openapi.json get /v3/id-mappings openapi: 3.0.0 info: title: Hifi API version: 3.0.0 description: API documentation for HIFI servers: - url: https://production.hifi.com description: Production server - url: https://sandbox.hifi.com description: Sandbox server security: - bearerAuth: [] tags: - name: Common description: Common endpoints - name: User description: User endpoints - name: Counter Party description: Counter party endpoints - name: Crypto Transfer description: Crypto transfer and batch transfer endpoints - name: Wallet description: Wallet and wallet offer endpoints - name: External Account description: External bank account endpoints (under a counter party) - name: External Wallet description: External wallet endpoints (under a counter party) - name: External Card description: External card endpoints (under a counter party) - name: Token Swap description: Token swap endpoints - name: Bridge description: Bridge endpoints - name: Virtual Account description: Virtual account endpoints - name: Compliance description: Compliance and compliance link endpoints - name: Webhook Endpoint description: Webhook endpoint endpoints - name: File description: File upload endpoints - name: Onramp description: Onramp (fiat to crypto) endpoints - name: Offramp description: Offramp (crypto to fiat) endpoints - name: Orchestration Address description: Orchestration (liquidation) address endpoints - name: KYC Link description: Hosted and custom KYC/KYB link endpoints - name: Transfer Approval description: Transfer approval endpoints - name: Corridor description: Supported fiat/crypto transfer corridor endpoints - name: Migration description: v2-to-v3 ID mapping endpoints paths: /v3/id-mappings: get: tags: - Migration summary: Map v2 IDs to v3 IDs description: > Resolve up to 1000 v2 resource UUIDs to their corresponding v3 public IDs. Entries that cannot be resolved (unknown ID, or a `resourceType` without a migration mapping) are returned with `v3Id: null` and `mapped: false` rather than causing the whole request to fail. This is a `GET` request with a JSON request body; ensure your HTTP client and any intermediate proxies are configured to send a body with `GET`. operationId: v3MapIds requestBody: $ref: '#/components/requestBodies/IdMappingBatchBody' responses: '200': $ref: '#/components/responses/IdMappingResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' components: requestBodies: IdMappingBatchBody: required: true description: v2 IDs to resolve to their v3 public IDs. content: application/json: schema: $ref: '#/components/schemas/IdMappingBatch' example: ids: - v2Id: 8f14e45f-ceea-467e-adde-0f8d0f5f4b1c resourceType: USER responses: IdMappingResponse: description: v2-to-v3 ID mapping results, in the same order as the request. content: application/json: schema: $ref: '#/components/schemas/IdMappingResult' example: ids: - resourceType: USER v2Id: 8f14e45f-ceea-467e-adde-0f8d0f5f4b1c v3Id: usr_3Kf9dQ2mNpXwZ7bV1aLcs mapped: true BadRequestResponse: description: Bad Request — the request was malformed or failed validation. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: type: VALIDATION_ERROR message: One or more fields are invalid or missing. fields: - code: invalid_value message: Must be a valid email address field: email UnauthorizedResponse: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized' InternalServerErrorResponse: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' schemas: IdMappingBatch: type: object description: Up to 1000 v2 IDs to resolve to their v3 public IDs. required: - ids properties: ids: type: array minItems: 1 maxItems: 1000 items: $ref: '#/components/schemas/IdMappingEntry' IdMappingResult: type: object properties: ids: type: array items: $ref: '#/components/schemas/IdMappingResultEntry' ApiError: type: object description: >- Standard v3 error shape, returned by validation failures and business-logic errors alike. properties: type: type: string description: >- Machine-readable error type, e.g. VALIDATION_ERROR, ACTION_NOT_ALLOWED, RESOURCE_CONFLICT. example: VALIDATION_ERROR message: type: string description: Human-readable error message. example: One or more fields are invalid or missing. fields: type: array description: >- Present on field-level validation errors. One entry per problem field. items: type: object properties: code: type: string description: Error code related to the field issue. message: type: string description: Error message for the specific issue. field: type: string description: The name of the field that has an issue. Unauthorized: type: object properties: type: type: string description: Unauthorized enum example: UNAUTHORIZED message: type: string description: Unauthorized message example: Authentication required InternalServerError: type: object properties: type: type: string example: INTERNAL_SERVER_ERROR description: Internal server error enum message: type: string example: An internal server error occurred description: Internal server error message IdMappingEntry: type: object description: A single v2-to-v3 ID mapping request. required: - v2Id - resourceType properties: v2Id: type: string format: uuid description: The resource's internal v2 UUID. example: 8f14e45f-ceea-467e-adde-0f8d0f5f4b1c resourceType: type: string enum: - USER - WALLET_DEPOSIT - EXTERNAL_WALLET - OFFER - VIRTUAL_ACCOUNT - EXTERNAL_ACCOUNT - ONRAMP - OFFRAMP - CRYPTO_TRANSFER - BATCH_CRYPTO_TRANSFER - SWAP - BRIDGE - SETTLEMENT_RULE - ORCHESTRATION_ADDRESS - ORCHESTRATION_DEPOSIT - ORCHESTRATION_BATCH example: USER IdMappingResultEntry: type: object description: >- The resolved v3 public ID for a single requested v2 ID, if it could be mapped. properties: resourceType: type: string example: USER v2Id: type: string format: uuid example: 8f14e45f-ceea-467e-adde-0f8d0f5f4b1c v3Id: type: string nullable: true description: The corresponding v3 public ID, or `null` if it could not be mapped. example: usr_3Kf9dQ2mNpXwZ7bV1aLcs mapped: type: boolean example: true securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````