---
title: "Authentication - Create"
method: POST
path: "/authentication"
tags: ["Authentication"]
---

# Authentication - Create

`POST /authentication`

Create a new authentication for accessing our APIs from your servers.

## Request body

- AuthenticationCreateRequest
  - `authentication_id` string, nullable — The unique identifier for this authentication.
  - `profile_id` string, nullable — The business profile that is associated with this authentication
  - `amount` integer, required — This Unit struct represents MinorUnit in which core amount works
  - `authentication_connector` 'threedsecureio' | 'netcetera' | 'gpayments' | 'ctp_mastercard' | 'unified_authentication_service' | 'juspaythreedsserver' | 'ctp_visa' | 'cardinal'
  - `currency` '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' | 'CLF' | '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' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | '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', required — The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.
  - `return_url` string, nullable — The URL to which the user should be redirected after authentication.
  - `force_3ds_challenge` boolean, nullable — Force 3DS challenge.
  - `psd2_sca_exemption_type` 'low_value' | 'transaction_risk_analysis' — SCA Exemptions types available for authentication
  - `profile_acquirer_id` string, nullable — Profile Acquirer ID get from profile acquirer configuration
  - `acquirer_details` AcquirerDetails
    - `acquirer_bin` string, nullable — The bin of the card.
    - `acquirer_merchant_id` string, nullable — The merchant id of the card.
    - `merchant_country_code` string, nullable — The country code of the card.
  - `customer_details` CustomerDetails — Passing this object creates a new customer or attaches an existing customer to the payment
    - `id` string, nullable — The identifier for the customer.
    - `name` string, nullable — The customer's name
    - `email` string, nullable — The customer's email address
    - `phone` string, nullable — The customer's phone number
    - `phone_country_code` string, nullable — The country code for the customer's phone number
    - `tax_registration_id` string, nullable — The tax registration identifier of the customer.
    - `document_details` CustomerDocumentDetails
      - `document_type` 'cpf' | 'cnpj' | 'psn' | 'other', required — Represents the type of identification document used for validation.
      - `document_number` string, required — The customer's document number Length of the document number depends upon the document_type. For CPF/CNPJ it is typically 11/14 digits long

## Response `200`

Authentication created

- AuthenticationResponse
  - `authentication_id` string, required — The unique identifier for this authentication.
  - `merchant_id` string, required — This is an identifier for the merchant account. This is inferred from the API key provided during the request
  - `status` 'started' | 'pending' | 'success' | 'failed', required
  - `client_secret` string, nullable — The client secret for this authentication, to be used for client-side operations.
  - `amount` integer, required — This Unit struct represents MinorUnit in which core amount works
  - `currency` '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' | 'CLF' | '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' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | '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', required — The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.
  - `authentication_connector` 'threedsecureio' | 'netcetera' | 'gpayments' | 'ctp_mastercard' | 'unified_authentication_service' | 'juspaythreedsserver' | 'ctp_visa' | 'cardinal'
  - `force_3ds_challenge` boolean, nullable — Whether 3DS challenge was forced.
  - `return_url` string, nullable — The URL to which the user should be redirected after authentication, if provided.
  - `created_at` string, date-time, nullable
  - `error_code` string, nullable
  - `error_message` string, nullable — If there was an error while calling the connector the error message is received here
  - `profile_id` string, nullable — The business profile that is associated with this payment
  - `psd2_sca_exemption_type` 'low_value' | 'transaction_risk_analysis' — SCA Exemptions types available for authentication
  - `acquirer_details` AcquirerDetails
    - `acquirer_bin` string, nullable — The bin of the card.
    - `acquirer_merchant_id` string, nullable — The merchant id of the card.
    - `merchant_country_code` string, nullable — The country code of the card.
  - `profile_acquirer_id` string, nullable — Profile Acquirer ID get from profile acquirer configuration
  - `customer_details` CustomerDetails — Passing this object creates a new customer or attaches an existing customer to the payment
    - `id` string, nullable — The identifier for the customer.
    - `name` string, nullable — The customer's name
    - `email` string, nullable — The customer's email address
    - `phone` string, nullable — The customer's phone number
    - `phone_country_code` string, nullable — The country code for the customer's phone number
    - `tax_registration_id` string, nullable — The tax registration identifier of the customer.
    - `document_details` CustomerDocumentDetails
      - `document_type` 'cpf' | 'cnpj' | 'psn' | 'other', required — Represents the type of identification document used for validation.
      - `document_number` string, required — The customer's document number Length of the document number depends upon the document_type. For CPF/CNPJ it is typically 11/14 digits long

## Other responses

- `400` — Invalid data

---

[API](https://skmtc.net/hyperswitch/apis/dynamic-routing-openapi-3-0.md) · [All operations](https://skmtc.net/hyperswitch/apis/dynamic-routing-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hyperswitch/dynamic-routing-openapi-3-0/revisions/8fbf69ab2597/schema)