> ## Documentation Index > Fetch the complete documentation index at: https://docs.hub2.io/llms.txt > Use this file to discover all available pages before exploring further. # Create a delegated IRT transfer > Make an IRT transfer using your own provider credentials. ## OpenAPI ````yaml post /delegated/transfers/irt openapi: 3.0.0 info: title: Hub2 Service · Api description: |- This is the Hub2 api reference | Please check https://docs.hub2.io/ for the full documentation | Rate limits of endpoints are here : https://docs.hub2.io/en/details/limits.html. version: 2.149.1 contact: name: Hub2 url: https://www.hub2.io/ email: contact@hub2.io servers: [] security: [] tags: - name: Payments description: >- Best known as the PAY-IN API, it provides endpoints for merchants to perform Hub2 PAY-IN transactions. - name: Transfers description: >- Best known as the PAY-OUT API, it provides endpoints for merchants to perform Hub2 PAY-OUT transactions. - name: IRT description: International Remittance Transfers - name: Balance description: '' - name: Webhooks description: '' - name: Provisioning description: '' - name: Payment on Terminal description: '' - name: Receipt description: '' - name: Sms description: '' - name: Data description: '' - name: Compliance description: '' - name: Recipient description: '' - name: Delegation description: '' - name: Deposits description: '' - name: Payment Links description: '' - name: Submerchants description: '' paths: /delegated/transfers/irt: post: tags: - Delegation summary: Create a delegated IRT transfer description: Make an IRT transfer using your own provider credentials. operationId: DelegationController_createDelegatedTransferIrt parameters: - name: ApiKey in: header description: >- Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team. required: true schema: type: string - name: MerchantId in: header description: >- Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team. required: true schema: type: string - name: Environment in: header description: >- Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions. required: true schema: enum: - live - sandbox type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatedDelegatedTransferIrtDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/TransferDto' '401': description: Wrong credentials content: application/json: schema: $ref: '#/components/schemas/ApiUnauthorizedErrorAlias' '429': description: 'ThrottlerException: Too Many Requests' content: application/json: schema: $ref: '#/components/schemas/ApiTooManyRequestErrorAlias' '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/ApiInternalErrorAlias' components: schemas: CreatedDelegatedTransferIrtDto: type: object properties: reference: type: string description: >- A reference provided by the client during the creation of this Transfer example: REM-20240619-00123 srcCountry: type: string description: Source country example: CI enum: - AF - AX - 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 - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - 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 - KR - KP - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - 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 - RE - RO - RU - RW - 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 - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW srcZone: type: string description: >- Zone of the source country. If the country does not belong to a zone, set it to 'other' example: UEMOA enum: - uemoa - cemac - africa - world - eur srcCurrency: type: string description: Currency of source country example: XOF enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL srcAmount: type: number description: Amount at the originating transaction example: 50000 forexRate: type: string description: Forex rate between corridors example: '655.957' purpose: type: string description: Purpose of the transfer example: Family support srcOriginFunds: type: string description: Origin of funds example: salary enum: - salary - personal_savings - pension_releases - share_sales_and_dividends - property_sales - gambling_winnings - inheritances_and_gift - compensation_from_legal_rulings srcOperator: type: string description: Source operator example: orange destinationCurrency: type: string description: Destination currency example: XOF enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL destination: description: Information about the recipient of this Transfer oneOf: - $ref: '#/components/schemas/IrtMobileMoneyDto' - $ref: '#/components/schemas/IrtBankTransferDto' discriminator: propertyName: type mapping: bank_transfer: $ref: '#/components/schemas/IrtBankTransferDto' mobile_money: $ref: '#/components/schemas/IrtMobileMoneyDto' title: Destination senderKyc: description: Sender KYC information allOf: - $ref: '#/components/schemas/SenderCustomerInformation' recipientKyc: description: Recipient KYC information allOf: - $ref: '#/components/schemas/RecipientCustomerInformation' description: type: string description: >- An arbitrary string attached to the Transfer. Mostly useful for displaying to user. overrideBusinessName: type: string description: >- This field is mandatory for aggregators and allows you to override the business name displayed to the end users. This is useful if you don't want your clients to see "Hub2" as the target of their payment but your company name instead. example: MyBusiness bankName: type: string description: Bank name example: UBA Bank transferInformation: description: >- Optional merchant-defined payment metadata. Persisted and returned on the transfer. example: recipient_name_hashmac: hash_xyz_789 transaction_purpose: SALARY allOf: - $ref: '#/components/schemas/TransferInformationDto' aggregatedMerchantId: type: string description: Aggregated merchant id title: aggregatedMerchantId required: - reference - srcCountry - srcCurrency - srcAmount - purpose - srcOriginFunds - srcOperator - destinationCurrency - destination - senderKyc - recipientKyc - aggregatedMerchantId TransferDto: type: object properties: id: type: string description: Unique identifier for the Transfer example: tr_z1urYtVFgEebtcj8fxp4v merchantId: type: string description: Identifier of the merchant owning this Transfer createdAt: type: string description: |- Datetime in UTC timezone at which this object was created. Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601). example: '2020-10-15T12:09:49.355Z' updatedAt: type: string description: >- Datetime in UTC timezone at which this object was updated for the last time . Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601). example: '2020-10-15T12:16:26.128Z' reference: type: string description: >- A reference provided by the client during the creation of this Transfer example: ref_2020_11_10_001 description: type: string description: >- An arbitrary string attached to the Transfer. Mostly useful for displaying to user. status: type: string description: The current status of this Transfer example: successful enum: - created - successful - pending - failed amount: type: number description: >- Amount intended to be sent to the recipient. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency). example: 100 currency: type: string description: >- Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html). example: XOF mode: type: string description: |- Mode in which this transfer exists. The sandbox mode can be used during the integration phase and is available as soon as the merchant account is created. No real transactions are made in this mode. The live mode has to be used to make real transactions. example: live enum: - live - sandbox destination: description: Information about the recipient of this Transfer oneOf: - $ref: '#/components/schemas/MobileMoneyDto' - $ref: '#/components/schemas/BankTransferDto' - $ref: '#/components/schemas/AirtimeDto' discriminator: propertyName: type mapping: bank_transfer: $ref: '#/components/schemas/BankTransferDto' mobile_money: $ref: '#/components/schemas/MobileMoneyDto' airtime: $ref: '#/components/schemas/AirtimeDto' title: Destination fees: description: Fees applied to merchant's transfer-account uppon success title: TransferFee type: array items: $ref: '#/components/schemas/TransferFeeDto' failureCause: description: >- In case of failure, this object will describe the reason of the failure title: TransferFailureCause allOf: - $ref: '#/components/schemas/TransferFailureCauseDto' origin: description: Information about the origin of this transfer title: Origin allOf: - $ref: '#/components/schemas/OriginDto' overrideBusinessName: type: string description: override business name for aggregator title: overrideBusinessName overrideBusinessId: type: string description: override business id for merchant title: overrideBusinessId isIrt: type: boolean description: indicate if the transfer was international title: isIrt providerReference: type: string description: provider reference that identify this transfer title: providerReference gatewayId: type: string description: The gateway ID used for this transfer title: gatewayId isDelegated: type: boolean description: Indicates if the transfer is delegated title: isDelegated aggregatedMerchantId: type: string description: Aggregated merchant id title: aggregatedMerchantId providerData: type: object description: Provider data title: providerData subMerchantId: type: string description: Submerchant ID example: submerchant_123 transferInformation: description: Merchant-defined payment metadata from transfer creation. example: recipient_name_hashmac: hash_xyz_789 transaction_purpose: SALARY allOf: - $ref: '#/components/schemas/TransferInformationDto' required: - id - merchantId - createdAt - updatedAt - reference - description - status - amount - currency - mode - destination - fees - isIrt - providerReference - gatewayId - isDelegated - aggregatedMerchantId ApiUnauthorizedErrorAlias: type: object properties: status: type: number description: HTTP error code. example: 401 error: description: HTTP error description. allOf: - $ref: '#/components/schemas/InternalApiUnauthorizedError' required: - status - error ApiTooManyRequestErrorAlias: type: object properties: status: type: number description: status enum: - 429 example: 429 error: type: string description: Error example: 'ThrottlerException: Too Many Requests' required: - status - error ApiInternalErrorAlias: type: object properties: type: type: string description: The type of this error. example: internal_error code: type: string description: The error code for this error. example: - internal_error - wrong_credentials - not_granted - live_mode_not_granted - invalid_sandbox_msisdn - invalid_url - orange_invalid_url - wrong_provider - override_business_name - do_not_override_business_name message: type: string description: The error message describing what happens to throw this error. example: An error occurred on our system. Please try again later. required: - type - code - message IrtMobileMoneyDto: type: object properties: type: type: string description: The method selected to make this Transfer example: mobile_money enum: - mobile_money - bank_transfer - airtime country: type: string description: >- Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. example: CI msisdn: type: string description: The Mobile Money number to which the money must be sent. provider: type: string description: >- The name of the provider selected by the customer, in lowercase. The list of supported providers can be found at [/data/providers](#operation/DataController_getProviders) example: orange required: - type - country - msisdn - provider IrtBankTransferDto: type: object properties: type: type: string description: The method selected to make this Transfer example: mobile_money enum: - mobile_money - bank_transfer - airtime country: type: string description: >- Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. example: CI accountNumber: type: string description: The Bank account number to which the money must be sent. accountOwner: type: string description: The Bank account owner name to which the money must be sent. bankCode: type: string description: The Bank code. bankName: type: string description: The Bank name. beneficiaryPhone: type: string description: The benificiary number required: - type - country - accountNumber - accountOwner - bankCode - bankName - beneficiaryPhone SenderCustomerInformation: type: object properties: firstName: type: string description: First name of the sender example: Aminata lastName: type: string description: Last name of the sender example: Traoré contactPhone: type: string description: Contact phone number of the sender example: '+2250747123456' dateOfBirth: type: string description: Date of birth of the sender in YYYY-MM-DD format example: '1992-05-23' nationality: type: string description: Nationality of the sender example: CI enum: - AF - AX - 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 - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - 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 - KR - KP - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - 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 - RE - RO - RU - RW - 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 - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW idDocument: description: ID document information of the sender allOf: - $ref: '#/components/schemas/IdDocumentDto' required: - firstName - lastName - contactPhone - dateOfBirth - nationality - idDocument RecipientCustomerInformation: type: object properties: firstName: type: string description: First name of the recipient example: Moussa lastName: type: string description: Last name of the recipient example: Konaté contactPhone: type: string description: Contact phone number of the recipient example: '+223657890123' required: - firstName - lastName - contactPhone TransferInformationDto: type: object properties: recipient_name_hashmac: type: string description: >- Full name of the person receiving the funds (hashed on the partner side). example: hash_xyz_789 maxLength: 50 recipient_phone_hashmac: type: string description: >- Partner-side HMAC or cryptographic hash of the recipient MSISDN (not the clear number). Requests that send a plain phone number in this field are rejected. example: a3f2c9e1b8d7... maxLength: 50 customer_id_hashmac: type: string description: >- Partner-side hashed customer identifier. Use when name or phone cannot be sent, to correlate transactions for fraud analysis. example: hash_cust_abc maxLength: 50 transaction_purpose: type: string description: Declared purpose of the payout for compliance and monitoring. enum: - SALARY - LOAN_DISBURSEMENT - COMMISSION - REFUND - CASHOUT - OTHER example: SALARY MobileMoneyDto: type: object properties: type: type: string description: The method selected to make this Transfer example: mobile_money enum: - mobile_money - bank_transfer - airtime country: type: string description: >- Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. example: CI recipientName: type: string description: recipient's Name number: type: string description: |- The identifier referencing the payment method of the customer. - In case of a payment by Mobile Money, it corresponds to the customer phone number corresponding to his Mobile Money account provider: type: string description: >- The name of the provider selected by the customer, in lowercase. The list of supported providers can be found at [/data/providers](#operation/DataController_getProviders) example: orange required: - type - country - number - provider BankTransferDto: type: object properties: type: type: string description: The method selected to make this Transfer example: mobile_money enum: - mobile_money - bank_transfer - airtime country: type: string description: >- Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. example: CI recipientName: type: string description: recipient's Name number: type: string description: |- The identifier referencing the payment method of the customer. - In case of a payment by Bank Transfer, it corresponds to the customer bank account number accountOwner: type: string description: The Bank account owner name to which the money must be sent. bankCode: type: string description: The Bank code. bankName: type: string description: The Bank name. beneficiaryPhone: type: string description: The Beneficiary phone required: - type - country - number - accountOwner - bankCode - bankName - beneficiaryPhone AirtimeDto: type: object properties: type: type: string description: The method selected to make this Transfer example: mobile_money enum: - mobile_money - bank_transfer - airtime country: type: string description: >- Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Represents the country where the provider selected by the customer is localized. example: CI recipientName: type: string description: recipient's Name number: type: string description: |- The identifier referencing the payment method of the customer. - In case of a payment by Airtime, it corresponds to the customer phone number corresponding to his Airtime account provider: type: string description: >- The name of the provider selected by the customer, in lowercase. The list of supported providers can be found at [/data/providers](#operation/DataController_getProviders) example: orange required: - type - country - number - provider TransferFeeDto: type: object properties: id: type: string description: Unique identifier of the applied Fee object. example: lAe5HnFpvOjwdT9vSIgPA rate: type: number description: >- A rate corresponding to the amount (flat or percentage) applied by the fees. type: type: string description: |- The type of fee applied to the transfer's amount - flat: A fixed amount applied as is to the amount. - percent: A rate applied to the amount as a percentage of the latter. enum: - flat - percent amount: type: number description: >- Amount applied by this Fees. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge €1.00 or 100 to charge FCFA100, a zero-decimal currency). example: 5 currency: type: string description: >- Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html). example: XOF label: type: string description: An optional label giving information on the reason of this fees. taxes: description: An array containing every taxes applied to a fee type: array items: type: string required: - id - rate - type - amount - currency - taxes TransferFailureCauseDto: type: object properties: code: type: string message: type: string params: type: array items: type: string required: - code - message - params OriginDto: type: object properties: name: type: string description: Sender's name country: type: string description: >- Sender's country. Two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) InternalApiUnauthorizedError: type: object properties: type: type: string description: The type of this error. example: authorization_error code: type: string description: The internal error code describing what happened. enum: - bad_payment_intent_token - wrong_credentials example: wrong_credentials message: type: string description: Detailed error message which describe what happened. example: L'ID marchand et/ou la clé d'API sont incorrects. required: - type - code - message IdDocumentDto: type: object properties: expiryDate: format: date-time type: string description: Expiry date of the ID document in ISO 8601 format example: '2025-12-31' idNumber: type: string description: The ID document number example: '123456789' idType: type: string description: Type of ID document enum: - alienregistration - birthcertificate - drivinglicence - employer - healthcard - marriagecertificate - nationalidcard - nationalregistration - officialletter - othered - pancard - passport - seniorcitizenscard - socialsecurity - taxid - villageelderletter - votersid example: passport issueDate: format: date-time type: string description: Issue date of the ID document in ISO 8601 format example: '2020-01-01' issuer: type: string description: Issuing authority of the ID document example: Ministry of Interior issuerCountry: type: string description: Country that issued the ID document enum: - AF - AX - 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 - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - 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 - KR - KP - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - 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 - RE - RO - RU - RW - 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 - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW example: CI issuerPlace: type: string description: Place where the ID document was issued example: Abidjan otherIdDescription: type: string description: Description for other types of ID documents example: Custom identification document required: - idNumber - idType ````