> ## 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 kyb ## OpenAPI ````yaml post /compliance/kyb 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: /compliance/kyb: post: tags: - Compliance summary: Create a kyb operationId: ComplianceController_createKyb 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/CreateKybDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/KybDto' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiBadRequestErrorAlias' '401': description: Wrong credentials content: application/json: schema: $ref: '#/components/schemas/ApiUnauthorizedErrorAlias' '409': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ApiInvalidRequestErrorAlias' '500': description: Internal error content: application/json: schema: $ref: '#/components/schemas/ApiInternalErrorAlias' components: schemas: CreateKybDto: type: object properties: merchantId: type: string description: The id identifying the merchant example: '156' name: type: string description: Name of the declared sub-merchant example: Example merchant businessType: type: string description: Type of business of the sub-merchant example: Fintech businessRegistrationId: type: string description: Business registration id taxNumber: type: string description: Tax number directorName: type: string description: Director name websiteUrl: type: string description: Website url of the company country: type: string description: Country where the company is located example: CI headquarterAddress: type: string description: Address of the headquarter of the company required: - merchantId - name - businessType - businessRegistrationId - taxNumber - directorName - websiteUrl - country - headquarterAddress KybDto: type: object properties: merchantId: type: string description: The id identifying the merchant example: '156' name: type: string description: Name of the declared sub-merchant example: Example merchant businessType: type: string description: Type of business of the sub-merchant example: Fintech businessRegistrationId: type: string description: Business registration id taxNumber: type: string description: Tax number directorName: type: string description: Director name websiteUrl: type: string description: Website url of the company country: type: string description: Country where the company is located example: CI headquarterAddress: type: string description: Address of the headquarter of the company id: type: number description: The id identifying the kyb example: 1 createdAt: format: date-time 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' deletedAt: type: object description: |- Datetime in UTC timezone at which this object was deleted. Follows the [Datetime ISO](https://en.wikipedia.org/wiki/ISO_8601). Can be null. example: null required: - merchantId - name - businessType - businessRegistrationId - taxNumber - directorName - websiteUrl - country - headquarterAddress - id - createdAt - deletedAt ApiBadRequestErrorAlias: type: object properties: status: type: number description: HTTP error code. example: 400 error: description: HTTP error description. allOf: - $ref: '#/components/schemas/InternalApiBadRequestError' required: - status - error 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 ApiInvalidRequestErrorAlias: type: object properties: httpStatus: type: number description: Http status enum: - 409 example: 409 type: type: string description: Error type example: invalid_request code: type: string description: Error code enum: - unsupported_action example: unsupported_action message: type: string description: Error message example: This action is not supported required: - httpStatus - type - code - message 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 InternalApiBadRequestError: type: object properties: statusCode: type: number description: HTTP error code. example: 400 message: description: >- Detailed error message or array of messages to describe what's wrong. example: - destination.provider must be a string type: array items: type: string error: type: string description: The error message example: Bad Request required: - statusCode - message - error 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 ````