> ## Documentation Index > Fetch the complete documentation index at: https://docs.mansa.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Get ID types for a country > ID document types accepted for an individual Sender from a country. Use one as `id_type` when submitting personal payer details. ## OpenAPI ````yaml openapi-payouts-v2-0-0.json get /api/v2/payouts/senders/id-types openapi: 3.0.3 info: title: Mansa Payout API — v2 description: > Pay a Beneficiary's bank account in fiat, funded with USDT from your Mansa payout vault. ## Integration flow 1. Register a **Sender** (the payer named on the bank transfer). 2. Upload KYC documents and submit the Sender's payer details. Wait for `status: ready`. 3. Register a **Beneficiary** (who gets paid). Wait for `status: ready`. 4. Fetch the **purpose codes** accepted for that Sender and Beneficiary. 5. Create a **batch** of orders. Each order comes back quoted in USDT. 6. Make sure your payout vault holds enough USDT, then **confirm** the batch. 7. Track the batch until every order is `COMPLETED` or `FAILED`. Steps 2 and 3 involve a manual review on our side, so they are asynchronous: poll the `refresh` endpoints until `status` is `ready`. ## Conventions - Your organization must have the Payout product enabled (`GET /api/v2/liquidity/onboarding/products` shows `payout` as enabled). - All request and response fields are `snake_case`, with two exceptions: the `fileType` multipart form field and the `beneficiaryId` query parameter on the purposes endpoint. - Amounts are decimal strings (for example `"100.00"`), never numbers. - Timestamps are ISO-8601 UTC strings. - Partner details are never exposed. Statuses and error messages are Mansa's own. ## Rate Limiting - 100 requests per minute per API key - Specific endpoints may have additional limits ## Error Handling This API returns Nest's default error shape rather than a custom envelope. - **2xx** — The request succeeded. - **4xx** — The request failed due to a problem with the information provided. - **5xx** — A problem occurred on our servers or with an upstream dependency. Most errors have the shape: ```json { "statusCode": 400, "message": "..." } ``` Request-validation failures return `400` with every problem listed in `message` as an array, plus `"error": "Bad Request"`. Money-moving calls (`confirm`) are checked before any funds move, so a rejected confirm leaves the batch unchanged and can be retried after you fix the cause. version: v2 contact: name: Mansa API Support email: api-support@mansa.io url: https://docs.mansa.io license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.mansa.xyz description: Production server - url: https://sandbox-api.mansa.xyz description: Sandbox server security: - ApiKeyAuth: [] BearerAuth: [] tags: - name: Organizations description: Product entitlement checks - name: Senders description: Registering and verifying the org's own paying entities - name: Beneficiaries description: Registering and verifying who gets paid. Not tied to a Sender. - name: Funding description: The org's USDT funding address and balance - name: Payouts description: Creating, funding, and tracking payout batches and orders paths: /api/v2/payouts/senders/id-types: get: tags: - Senders summary: Get ID types for a country description: >- ID document types accepted for an individual Sender from a country. Use one as `id_type` when submitting personal payer details. operationId: getSenderIdTypes parameters: - name: country in: query required: true description: ISO 3166-1 alpha-2 schema: type: string minLength: 2 maxLength: 2 example: HK responses: '200': description: ID types for the country content: application/json: schema: $ref: '#/components/schemas/SenderIdTypesResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' components: schemas: SenderIdTypesResponse: type: object properties: country: type: string example: HK id_types: type: array items: type: string example: - ID_CARD - PASSPORT - DRIVING_LICENSE required: - country - id_types BadRequestError: type: object description: >- A business-rule failure has a string `message`. A request-validation failure lists every problem in `message` as an array and adds `"error": "Bad Request"`, for example `{"statusCode": 400, "message": ["orders.0.beneficiary_amount must be a string"], "error": "Bad Request"}`. properties: statusCode: type: integer example: 400 message: oneOf: - type: string - type: array items: type: string error: type: string example: Bad Request required: - statusCode - message NestErrorResponse: type: object description: >- Error body. Branch on the HTTP status; treat `message` as human-readable text, not a stable code. properties: statusCode: type: integer example: 400 message: type: string example: sender not found required: - statusCode - message example: statusCode: 400 message: sender not found responses: BadRequest: description: >- Invalid request, Sender or Beneficiary not `ready`, mixed currencies in a batch, nothing left to confirm, or a purpose code not valid for the pair. Request-validation failures list every problem in `message` as an array. content: application/json: schema: $ref: '#/components/schemas/BadRequestError' examples: default: value: statusCode: 400 message: No DRAFT orders left to confirm in this batch Unauthorized: description: Authentication required or invalid credentials content: application/json: schema: $ref: '#/components/schemas/NestErrorResponse' examples: default: value: statusCode: 401 message: Unauthorized Forbidden: description: Payout product not enabled for your organization content: application/json: schema: $ref: '#/components/schemas/NestErrorResponse' examples: default: value: statusCode: 403 message: Forbidden resource RateLimited: description: Rate limit exceeded headers: X-RateLimit-Limit: description: Request limit per window schema: type: integer X-RateLimit-Remaining: description: Remaining requests in window schema: type: integer X-RateLimit-Reset: description: UNIX epoch seconds when the rate limit resets schema: type: integer content: application/json: schema: $ref: '#/components/schemas/NestErrorResponse' examples: default: value: statusCode: 429 message: Too many requests ServerError: description: Internal server or upstream error content: application/json: schema: $ref: '#/components/schemas/NestErrorResponse' examples: default: value: statusCode: 500 message: Internal server error securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: API key for authentication BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- ES256 JWT signed by the private key registered to the API key above. Claims: sub (=API key), uri, nbf, iat, exp, and bodyHash (HMAC-SHA512 of uri + rawBody + nbf using a shared secret, base64). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.