"use strict"; const {jsx: _jsx} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; const apiSpecs = { "name": "klarna-product-api-identity", "title": "Identity", "type": "klarna-network", "intendedFor": "partner_through_klarna", "version": "v2", "release": "default", "spec": { "openapi": "3.1.1", "info": { "title": "Klarna Partner Product API - Identity", "version": "v2/default" }, "security": [{ "klarna_api_key": [] }], "paths": { "/v2/identity/customer-token/introspect": { "post": { "summary": "Introspect a customer token issued in the account linking flow.\n", "description": "

Early ReleaseFeature under development, may not be fully available and is subject to change as we continue building the service in partnership with early users

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Introspect a customer token issued in the account linking flow to obtain more information regarding the token.

\n \n Operation ID:\n A unique identifier for the operation.\n \n tokenIntrospect\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that provide read access to verify if a customer has an existing Klarna account or to retrieve details from an account linking token.Read-Only Identity\n

\n \n SLA Service Class:\n The SLA Service Class this operation is classified at when evaluating SLA compliance.\n \n Operations, webhooks and other services that does not directly impact the core purchasing process in real-time and enables supplemental or secondary featuresTier 2 Services\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to introspect or revoke customer tokens issued in the account linking flow.Customer Token Management\n

", "operationId": "tokenIntrospect", "tags": ["Identity API"], "parameters": [{ "name": "Klarna-Customer-Token", "in": "header", "required": true, "x-validation-info": "Must be a valid customer token", "schema": { "$ref": "#/components/schemas/CustomerToken" } }, { "name": "Klarna-Integration-Metadata", "in": "header", "description": "Metadata about the integrator and originators of the request, a valid JSON object string literal, to improve troubleshooting. [Read more here](https://docs.klarna.com/api/kn/integration-resilience/#tagging)\n\nThe header value as appearing on the wire should be a JSON object string literal without newlines as produced by `JSON.stringify()`.\n\nExample: `Klarna-Integration-Metadata: {\"integrator\":{\"name\":\"AcquiringPartner\",\"session_reference\":\"ecomm_5555-474\",\"module_name\":\"subIntegrationPath\",\"module_version\":\"v1.0\"},\"originators\":[{\"name\":\"ecommerceCompany\",\"session_reference\":\"ecomm_5555-474\",\"module_name\":\"subIntegrationPath\",\"module_version\":\"v2.0\"}]}`", "content": { "application/json": { "schema": { "title": "application/json", "type": "object", "properties": { "integrator": { "description": "An integrator is the entity that is responsible for the integration with Klarna.", "type": "object", "properties": { "name": { "description": "The name of the integrator using SCREAMING_SNAKE_CASE.\n", "minLength": 1, "maxLength": 50, "type": "string", "pattern": "^[A-Z0-9_]+$", "example": "PSP" }, "session_reference": { "description": "A reference to the session that is being used.\n", "maxLength": 100, "minLength": 1, "type": "string" }, "module_name": { "description": "The name of the module that is being used to initiate the request\n", "maxLength": 50, "type": "string", "minLength": 1, "example": "psp-new-payment" }, "module_version": { "description": "The version of the module that is being used.\nCan be a semantic version, commit hash, date or any other versioning scheme to identify which code that issued the request.\n", "maxLength": 50, "type": "string", "minLength": 1 } }, "required": ["name", "session_reference"] }, "originators": { "description": "Array of originators that are responsible for the request.\nIf the request is sent through multiple systems before reaching the integrator, each system can be represented as an originator.\n", "type": "array", "maxItems": 10, "items": { "description": "An originator is the entity that is responsible for the request.", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the originator using SCREAMING_SNAKE_CASE.\n", "maxLength": 50, "minLength": 1, "pattern": "^[A-Z0-9_]+$", "example": "ECOMMERCE_COMPANY" }, "session_reference": { "description": "A reference to the session that is being used.\n", "maxLength": 100, "type": "string", "minLength": 1 }, "module_name": { "description": "The name of the module that is being used.\n", "maxLength": 50, "type": "string", "minLength": 1 }, "module_version": { "description": "The version of the module that is being used.\n", "maxLength": 50, "type": "string", "minLength": 1 } }, "required": ["name", "session_reference"] } } }, "required": ["integrator"] } } } }, { "in": "header", "name": "Partner-Correlation-Id", "required": false, "schema": { "description": "An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response.", "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "Klarna-Workload-Type", "in": "header", "required": false, "description": "Signal the processing priority of this request. Set to \"background\" to indicate a lower-priority request. Background requests are metered against a separate rate limit bucket, protecting interactive traffic quota. Omit this header for default interactive rate limiting. Use \"background\" for scheduled or bulk processing jobs such as settlement retrieval, bulk order management, or periodic reconciliation.", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "x-validation-info": "Accepts 'background' or 'standard'. Omitting the header defaults to interactive rate limiting. Klarna rejects unsupported values with 400 Bad Request.", "description": "\n\n**Open Enum - values** ([what is an open enum?](https://docs.klarna.com/klarna-network-distribution/setup-your-integration/integration-resilience/data-types/#open-enums)):\n\n| Value | Description |\n|-------|-------------|\n| `background` | Lower-priority processing — metered against a separate rate limit bucket. |\n| `standard` | Explicitly opt into the interactive rate limit bucket (same as omitting the header). |\n\n**Note:** This is an open enum. New values may be added in future releases. Integrators **must** implement handling for unknown values to ensure forward compatibility.", "x-extensible-enum": ["background", "standard"] } }], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "description": "Customer token introspection response.", "properties": { "status": { "type": "string", "description": "The status of the customer token.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ACTIVE` | |\n| `REVOKED` | |\n", "enum": ["ACTIVE", "REVOKED"] }, "scopes": { "type": "array", "maxItems": 30, "description": "The scopes of the requested `customer_token`. The scopes define the permissions of the token.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `payment:customer_not_present` | Enables payment tokenization of the customer, allows you to charge for subscriptions and on-demand when the customer is not present. |\n| `payment:customer_present` | Enables tokenization of the customer, subsequent charges depending on risk assessment and the initially selected payment method might go through immediately or, in certain cases, require step-up. |\n| `customer:login` | Enables account linking for the customer that allows the partner to create future payment requests in a logged in state for the customer. |\n", "items": { "type": "string", "enum": ["payment:customer_not_present", "payment:customer_present", "customer:login"], "description": "\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `payment:customer_not_present` | Enables payment tokenization of the customer, allows you to charge for subscriptions and on-demand when the customer is not present. |\n| `payment:customer_present` | Enables tokenization of the customer, subsequent charges depending on risk assessment and the initially selected payment method might go through immediately or, in certain cases, require step-up. |\n| `customer:login` | Enables account linking for the customer that allows the partner to create future payment requests in a logged in state for the customer. |\n" } }, "issued_at": { "type": "number", "description": "The timestamp when the token was issued." }, "customer_token_reference": { "$ref": "#/components/schemas/CustomerTokenReference" } }, "required": ["status", "scopes", "issued_at"] }, "examples": { "An active customer token issued with payment:customer_present scope": { "$ref": "#/components/examples/Customer_token_instrospection_response_for_active_customer_present" }, "A revoked customer token issued with payment:customer_present scope": { "$ref": "#/components/examples/Customer_token_instrospection_response_for_revoked_customer_present" } } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "409": { "description": "Conflict: The customer token referenced by the resource has been revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorCustomerTokenRevoked" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } } } } }, "/v2/identity/customer-token/revoke": { "post": { "summary": "Revoke a customer token issued in the account linking flow.\n", "description": "

Early ReleaseFeature under development, may not be fully available and is subject to change as we continue building the service in partnership with early users

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Revoke a customer token issued in the account linking flow, so that any subsequent payment requests using the token are rejected.

\n \n Operation ID:\n A unique identifier for the operation.\n \n tokenRevoke\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that allow the revocation or updates of a customer token issued during the account linking process.Identity\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to introspect or revoke customer tokens issued in the account linking flow.Customer Token Management\n

", "operationId": "tokenRevoke", "tags": ["Identity API"], "parameters": [{ "name": "Klarna-Customer-Token", "in": "header", "required": true, "x-validation-info": "Must be a valid customer token or purchase token ID", "schema": { "oneOf": [{ "$ref": "#/components/schemas/CustomerToken" }, { "$ref": "#/components/schemas/PurchaseTokenId" }] } }, { "name": "Klarna-Integration-Metadata", "in": "header", "description": "Metadata about the integrator and originators of the request, a valid JSON object string literal, to improve troubleshooting. [Read more here](https://docs.klarna.com/api/kn/integration-resilience/#tagging)\n\nThe header value as appearing on the wire should be a JSON object string literal without newlines as produced by `JSON.stringify()`.\n\nExample: `Klarna-Integration-Metadata: {\"integrator\":{\"name\":\"AcquiringPartner\",\"session_reference\":\"ecomm_5555-474\",\"module_name\":\"subIntegrationPath\",\"module_version\":\"v1.0\"},\"originators\":[{\"name\":\"ecommerceCompany\",\"session_reference\":\"ecomm_5555-474\",\"module_name\":\"subIntegrationPath\",\"module_version\":\"v2.0\"}]}`", "content": { "application/json": { "schema": { "title": "application/json", "type": "object", "properties": { "integrator": { "description": "An integrator is the entity that is responsible for the integration with Klarna.", "type": "object", "properties": { "name": { "description": "The name of the integrator using SCREAMING_SNAKE_CASE.\n", "minLength": 1, "maxLength": 50, "type": "string", "pattern": "^[A-Z0-9_]+$", "example": "PSP" }, "session_reference": { "description": "A reference to the session that is being used.\n", "maxLength": 100, "minLength": 1, "type": "string" }, "module_name": { "description": "The name of the module that is being used to initiate the request\n", "maxLength": 50, "type": "string", "minLength": 1, "example": "psp-new-payment" }, "module_version": { "description": "The version of the module that is being used.\nCan be a semantic version, commit hash, date or any other versioning scheme to identify which code that issued the request.\n", "maxLength": 50, "type": "string", "minLength": 1 } }, "required": ["name", "session_reference"] }, "originators": { "description": "Array of originators that are responsible for the request.\nIf the request is sent through multiple systems before reaching the integrator, each system can be represented as an originator.\n", "type": "array", "maxItems": 10, "items": { "description": "An originator is the entity that is responsible for the request.", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the originator using SCREAMING_SNAKE_CASE.\n", "maxLength": 50, "minLength": 1, "pattern": "^[A-Z0-9_]+$", "example": "ECOMMERCE_COMPANY" }, "session_reference": { "description": "A reference to the session that is being used.\n", "maxLength": 100, "type": "string", "minLength": 1 }, "module_name": { "description": "The name of the module that is being used.\n", "maxLength": 50, "type": "string", "minLength": 1 }, "module_version": { "description": "The version of the module that is being used.\n", "maxLength": 50, "type": "string", "minLength": 1 } }, "required": ["name", "session_reference"] } } }, "required": ["integrator"] } } } }, { "in": "header", "name": "Partner-Correlation-Id", "required": false, "schema": { "description": "An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response.", "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "Klarna-Workload-Type", "in": "header", "required": false, "description": "Signal the processing priority of this request. Set to \"background\" to indicate a lower-priority request. Background requests are metered against a separate rate limit bucket, protecting interactive traffic quota. Omit this header for default interactive rate limiting. Use \"background\" for scheduled or bulk processing jobs such as settlement retrieval, bulk order management, or periodic reconciliation.", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "x-validation-info": "Accepts 'background' or 'standard'. Omitting the header defaults to interactive rate limiting. Klarna rejects unsupported values with 400 Bad Request.", "description": "\n\n**Open Enum - values** ([what is an open enum?](https://docs.klarna.com/klarna-network-distribution/setup-your-integration/integration-resilience/data-types/#open-enums)):\n\n| Value | Description |\n|-------|-------------|\n| `background` | Lower-priority processing — metered against a separate rate limit bucket. |\n| `standard` | Explicitly opt into the interactive rate limit bucket (same as omitting the header). |\n\n**Note:** This is an open enum. New values may be added in future releases. Integrators **must** implement handling for unknown values to ensure forward compatibility.", "x-extensible-enum": ["background", "standard"] } }], "callbacks": { "identity.customer-token.state-change.revoked": { "klarna-webhook": { "description": "Webhook notification delivered when a customer token has been successfully revoked on Klarna's side.", "post": { "summary": "Webhook: Customer-token revoked", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.customer-token.state-change.revoked" }, "examples": { "Customer token revoked webhook": { "$ref": "#/components/examples/Identity_customer_token_revoked_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "description": "Customer token revocation response.", "properties": { "customer_token_reference": { "$ref": "#/components/schemas/CustomerTokenReference" } } }, "examples": { "A successful revocation response": { "$ref": "#/components/examples/Customer_token_revocation_response" } } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "409": { "description": "Conflict: The customer token referenced by the resource has been revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorCustomerTokenRevoked" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } } } } }, "/v2/identity/sdk-tokens": { "post": { "tags": ["Identity API"], "operationId": "generateIdentitySdkToken", "summary": "Generate SDK token", "description": "

DeprecatedFeature is deprecated and will soon be decommissioned.

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Deprecated: This operation is deprecated and will be removed.\nUse the /network/session/tokens endpoint to generate a Klarna network session token for SDK initialization and customer personalization.\nWhy: Klarna is moving to network session tokens for unified session management.\nMigration: Replace calls to /identity/sdk-tokens with /network/session/tokens and update your SDK initialization to use the klarna network session token.

\n \n Operation ID:\n A unique identifier for the operation.\n \n generateIdentitySdkToken\n

\n \n SLA Service Class:\n The SLA Service Class this operation is classified at when evaluating SLA compliance.\n \n Operations, webhooks and other services that are outside the scope of both Tier 1 and Tier 2 ServicesTier 3 Services\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to generate Klarna network session tokens for initializing Klarna integrations.Network Session Token\n

", "deprecated": true, "parameters": [{ "name": "Klarna-Customer-Token", "in": "header", "required": true, "x-validation-info": "Must be a valid customer token or purchase token ID", "schema": { "oneOf": [{ "$ref": "#/components/schemas/CustomerToken" }, { "$ref": "#/components/schemas/PurchaseTokenId" }] } }, { "name": "Klarna-Integration-Metadata", "in": "header", "description": "Metadata about the integrator and originators of the request, a valid JSON object string literal, to improve troubleshooting. [Read more here](https://docs.klarna.com/api/kn/integration-resilience/#tagging)\n\nThe header value as appearing on the wire should be a JSON object string literal without newlines as produced by `JSON.stringify()`.\n\nExample: `Klarna-Integration-Metadata: {\"integrator\":{\"name\":\"AcquiringPartner\",\"session_reference\":\"ecomm_5555-474\",\"module_name\":\"subIntegrationPath\",\"module_version\":\"v1.0\"},\"originators\":[{\"name\":\"ecommerceCompany\",\"session_reference\":\"ecomm_5555-474\",\"module_name\":\"subIntegrationPath\",\"module_version\":\"v2.0\"}]}`", "content": { "application/json": { "schema": { "title": "application/json", "type": "object", "properties": { "integrator": { "description": "An integrator is the entity that is responsible for the integration with Klarna.", "type": "object", "properties": { "name": { "description": "The name of the integrator using SCREAMING_SNAKE_CASE.\n", "minLength": 1, "maxLength": 50, "type": "string", "pattern": "^[A-Z0-9_]+$", "example": "PSP" }, "session_reference": { "description": "A reference to the session that is being used.\n", "maxLength": 100, "minLength": 1, "type": "string" }, "module_name": { "description": "The name of the module that is being used to initiate the request\n", "maxLength": 50, "type": "string", "minLength": 1, "example": "psp-new-payment" }, "module_version": { "description": "The version of the module that is being used.\nCan be a semantic version, commit hash, date or any other versioning scheme to identify which code that issued the request.\n", "maxLength": 50, "type": "string", "minLength": 1 } }, "required": ["name", "session_reference"] }, "originators": { "description": "Array of originators that are responsible for the request.\nIf the request is sent through multiple systems before reaching the integrator, each system can be represented as an originator.\n", "type": "array", "maxItems": 10, "items": { "description": "An originator is the entity that is responsible for the request.", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the originator using SCREAMING_SNAKE_CASE.\n", "maxLength": 50, "minLength": 1, "pattern": "^[A-Z0-9_]+$", "example": "ECOMMERCE_COMPANY" }, "session_reference": { "description": "A reference to the session that is being used.\n", "maxLength": 100, "type": "string", "minLength": 1 }, "module_name": { "description": "The name of the module that is being used.\n", "maxLength": 50, "type": "string", "minLength": 1 }, "module_version": { "description": "The version of the module that is being used.\n", "maxLength": 50, "type": "string", "minLength": 1 } }, "required": ["name", "session_reference"] } } }, "required": ["integrator"] } } } }, { "in": "header", "name": "Partner-Correlation-Id", "required": false, "schema": { "description": "An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response.", "type": "string", "minLength": 1, "maxLength": 255 } }, { "name": "Klarna-Workload-Type", "in": "header", "required": false, "description": "Signal the processing priority of this request. Set to \"background\" to indicate a lower-priority request. Background requests are metered against a separate rate limit bucket, protecting interactive traffic quota. Omit this header for default interactive rate limiting. Use \"background\" for scheduled or bulk processing jobs such as settlement retrieval, bulk order management, or periodic reconciliation.", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "x-validation-info": "Accepts 'background' or 'standard'. Omitting the header defaults to interactive rate limiting. Klarna rejects unsupported values with 400 Bad Request.", "description": "\n\n**Open Enum - values** ([what is an open enum?](https://docs.klarna.com/klarna-network-distribution/setup-your-integration/integration-resilience/data-types/#open-enums)):\n\n| Value | Description |\n|-------|-------------|\n| `background` | Lower-priority processing — metered against a separate rate limit bucket. |\n| `standard` | Explicitly opt into the interactive rate limit bucket (same as omitting the header). |\n\n**Note:** This is an open enum. New values may be added in future releases. Integrators **must** implement handling for unknown values to ensure forward compatibility.", "x-extensible-enum": ["background", "standard"] } }], "responses": { "201": { "description": "SDK token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDKTokenResponse" } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" } } } } } } }, "components": { "securitySchemes": { "klarna_api_key": { "in": "header", "name": "Authorization", "type": "apiKey", "description": "Use the Klarna API key as HTTP Basic Authentication credentials" } }, "schemas": { "CustomerToken": { "type": "string", "description": "Returned if Account Linking or payment tokenization was requested.\n\nThe customer token represents the tokenized customer and allows you to act\non behalf of the customer. You must persist this token in your system associated with the customer\naccount. To de-duplicate customers, you should use the `customer_id` as the unique identifier.\n", "maxLength": 1024, "minLength": 1, "example": "krn:partner:us1:live:identity:customer-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a", "x-validation-info": "Validation on the length (max length 1024) and the format of the string." }, "CustomerTokenReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Partner reference to the customer token created on Klarna side.\nThis will be exposed in webhooks related to changes to the customer token (e.g. token revoked) for the purpose of correlating your resource with the Klarna customer token.\n", "example": "partner_customer_token_1234" }, "PurchaseTokenId": { "type": "string", "description": "Payload parameter utilized in the Identity API for revoking legacy One Klarna Tokens (purchase tokens).\n\nThe One Klarna Token represents a customer's consent, allowing a merchant to charge their Klarna account\nor enabling Klarna to charge the customer's payment method or funding source without the customer being\nphysically present.\n", "minLength": 0, "example": "cd5262a5-9041-4453-a8dc-8dd63975d66d", "x-validation-info": "Validation on the format of the string." }, "WebhookHeaderKlarnaSignature": { "type": "string", "minLength": 0, "maxLength": 255, "example": "2bb80d537b1da3e38bd30361aa855686bde0ba1611657e8d211d0d71fb4f177e", "description": "HMAC-SHA256 signature over the HTTP request body signed with the key identified by `Klarna-Signing-Key-ID`. \n\nThe signature is calculated over the full HTTP request body.\n\n `computedHexDigest = HMAC_SHA256_HexDigest(request.body, getSecretKey(request.headers[\"Klarna-Signing-Key-ID\"]))`\n\nCompare the computed signature with the value of the `Klarna-Signature` header. If they match, the request is coming\nfrom Klarna and you can process the webhook. If they do not match, you should reject the request.\n" }, "WebhookHeaderKlarnaSigningKeyID": { "type": "string", "minLength": 0, "maxLength": 255, "description": "The key used to sign the webhook.", "example": "krn:partner:global:notification:signing-key:120e5b7e-dee8-43ca-9858-dca726e639b5" }, "WebhookMetadata": { "type": "object", "description": "The metadata of the webhook event.\n", "required": ["event_type", "event_version", "event_id", "occurred_at", "webhook_id", "recipient_account_id", "subject_account_id", "live"], "properties": { "event_id": { "type": "string", "minLength": 0, "maxLength": 255, "example": "28ac927f-5ba7-4589-8bf7-1c8ada082343", "description": "The unique identifier of the delivered event." }, "event_type": { "type": "string", "description": "The event type of the webhook.", "minLength": 0, "maxLength": 255 }, "event_version": { "type": "string", "minLength": 0, "maxLength": 255, "example": "v2", "description": "The version of the payload event schema." }, "occurred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the event occurred. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "subject_account_id": { "type": "string", "description": "The unique identifier of the account for which the event has occurred.", "example": "krn:partner:global:account:live:LWT2XJSE", "minLength": 0, "maxLength": 255 }, "recipient_account_id": { "type": "string", "description": "The unique identifier of the account that has configured the webhook and receives the notification.", "example": "krn:partner:global:account:live:LWT2XJSE", "minLength": 0, "maxLength": 255 }, "product_instance_id": { "type": "string", "description": "The unique identifier of the product instance.", "example": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "minLength": 0, "maxLength": 255 }, "webhook_id": { "type": "string", "description": "The unique identifier of the webhook that triggered the notification.", "example": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "minLength": 0, "maxLength": 255 }, "live": { "type": "boolean", "description": "A boolean flag indicating whether the event is generated in a production environment.", "example": true } } }, "identity.customer-token.state-change.revoked": { "type": "object", "description": "The common payload of a customer token revocation event.\n", "properties": { "metadata": { "$ref": "#/components/schemas/WebhookMetadata" }, "payload": { "type": "object", "description": "The payload of the customer token revocation event.\n", "required": ["customer_token"], "properties": { "customer_token": { "type": "string", "description": "Returned if Account Linking or payment tokenization was requested.\n\nThe customer token represents the tokenized customer and allows you to act\non behalf of the customer. You must persist this token in your system associated with the customer\naccount. To de-duplicate customers, you should use the `customer_id` as the unique identifier.\n", "maxLength": 1024, "minLength": 1, "example": "krn:partner:us1:live:identity:customer-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a", "x-validation-info": "The identifier representing a tokenized customer that allows partners to act on behalf of the customer. The format can be either a UUID (legacy purchase token) or a KRN (customer token)." }, "customer_token_reference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Partner reference to the customer token created on Klarna side.\nThis will be exposed in webhooks related to changes to the customer token (e.g. token revoked) for the purpose of correlating your resource with the Klarna customer token.\n", "example": "partner_customer_token_1234", "x-validation-info": "Partner reference to the customer token created on Klarna side." } } } } }, "GivenName": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Provide the given name (first name) of the person associated with the transaction.\nKlarna uses this value for customer communication, fraud assessment, and delivery validation.\nEnsure the name is accurate and matches the individual's legal or commonly used identity.\n", "x-validation-info": "Validation of length", "example": "John" }, "FamilyName": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Provide the family name (last name) of the person associated with the transaction.\nKlarna uses this value for customer communication, fraud assessment, and delivery validation.\nEnsure the name is complete and correctly reflects the recipient's or customer's identity.\n", "x-validation-info": "Validation of length", "example": "Doe" }, "Email": { "type": "string", "format": "email", "minLength": 6, "maxLength": 254, "description": "E-mail address.\n\nRegex:\n\n```\n^[!#$%&'*+\\-/0-9=?A-Z^_`a-z{|}~](\\.?[!#$%&'*+\\-/0-9=?A-Z^_`a-z{|}~])*@[a-zA-Z0-9](-*\\.?[a-zA-Z0-9])*\\.[a-zA-Z](-?[a-zA-Z0-9])+$\n```\n\nThis pattern is portable across JavaScript, PCRE, Python and Go (RE2):\nit uses no lookarounds, backreferences or engine-specific Unicode script\nclasses. It requires a dotted domain with an alphabetic top-level label\nand rejects leading, trailing or consecutive dots in the local part. The\nlocal part (max 64 characters) and total length (6–254 characters) are\nenforced by `format`, `minLength` and `maxLength`.\n", "x-validation-info": "Validation that the format is correct", "example": "john.doe@klarna.com" }, "Phone": { "type": "string", "description": "Phone number in E.164 format", "x-validation-info": "Validation that the phone is in E.164 format", "example": "+18445527621", "pattern": "^\\+\\d{1,3}\\d{1,12}$" }, "Country": { "type": "string", "example": "US", "description": "Provide the two-letter country code in ISO 3166‑1 alpha‑2 format for the indicated address.\nThe system accepts only predefined country codes such as US, DE, SE, and AU. Treat the country code as an opaque string, do not parse or interpret its structure.\n", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." }, "StreetAddress1": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Provide the first line of the street address, including the primary information, such as street name and number. \nTreat the value as an opaque string, do not validate or infer its structure.\n", "example": "800 N. High St" }, "StreetAddress2": { "minLength": 1, "maxLength": 99, "type": "string", "description": "Provide the second line of the street address if additional address details are needed.\nKlarna uses this field to capture supplementary information such as apartment, suite, or unit numbers.\nTreat the value as an opaque string, do not validate or infer its format. This field is optional and supports extended address data.\n", "example": "Ste. 400" }, "PostalCode": { "type": "string", "minLength": 1, "maxLength": 10, "example": "43215", "description": "Provide the postal code formatted according to the rules of the specified country.\nTreat the postal code as an opaque string, do not parse or validate its format beyond country-specific requirements.\n" }, "City": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Provide the city or town name for the address indicated.\nTreat the city name as an opaque string, do not validate or infer its structure.\n", "example": "Columbus" }, "Region": { "type": "string", "minLength": 1, "maxLength": 99, "description": "State/county/province/region formatted according to country. Mandatory for US and AU market. Validations according to ISO 3166-2 format, e.g. US-OH, US-NJ, AU-ACT, etc.", "example": "US-OH" }, "SupportedCountry": { "type": "string", "example": "US", "description": "Provide the two-letter country code in ISO 3166‑1 alpha‑2 format for the indicated address.\nThe system accepts only predefined country codes such as US, DE, SE, and AU. Treat the country code as an opaque string, do not parse or interpret its structure.\n\nSupported countries\n `AT`, `BE`, `CA`, `CH`, `CZ`, `DE`, `DK`, `ES`, `FI`, `FR`\n `GB`, `GR`, `HU`, `IE`, `IT`, `MX`, `NL`, `NO`, `NZ`, `PL`\n `PT`, `RO`, `SE`, `US`\n", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." }, "CustomerAddress": { "type": "object", "required": ["street_address", "city", "country"], "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "$ref": "#/components/schemas/Region" }, "country": { "$ref": "#/components/schemas/SupportedCountry" } }, "description": "The customers address as set on their customer account profile.\n" }, "Locale": { "type": "string", "minLength": 5, "maxLength": 16, "example": "en-US", "x-validation-info": "Validation that locale contain {language}-{region} syntax.", "description": "Preferred locale, in IETF BCP 47 format.\n\nSupported locales\n- `en-AU`\n- `de-AT`\n- `en-AT`\n- `nl-BE`\n- `fr-BE`\n- `en-BE`\n- `en-CA`\n- `fr-CA`\n- `cs-CZ`\n- `en-CZ`\n- `da-DK`\n- `en-DK`\n- `fi-FI`\n- `sv-FI`\n- `en-FI`\n- `fr-FR`\n- `en-FR`\n- `de-DE`\n- `en-DE`\n- `el-GR`\n- `en-GR`\n- `hu-HU`\n- `en-HU`\n- `en-IE`\n- `it-IT`\n- `en-IT`\n- `en-MX`\n- `es-MX`\n- `nl-NL`\n- `en-NL`\n- `en-NZ`\n- `nb-NO`\n- `en-NO`\n- `pl-PL`\n- `en-PL`\n- `pt-PT`\n- `en-PT`\n- `ro-RO`\n- `en-RO`\n- `es-ES`\n- `en-ES`\n- `sv-SE`\n- `en-SE`\n- `de-CH`\n- `fr-CH`\n- `it-CH`\n- `en-CH`\n- `en-GB`\n- `en-US`\n- `es-US`\n" }, "DateOfBirth": { "type": "string", "description": "Date of birth of the person on the format YYYY-MM-DD", "x-validation-info": "Validation that the value is of the right format and the date is not in the future.", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "example": "1970-01-01" }, "NationalIdentificationUS": { "type": "object", "description": "US Social Security Number (SSN)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "SSN in 9 digit format", "pattern": "^[0-9]{3}-[0-9]{2}-[0-9]{4}|[0-9]{9}$", "example": "999-99-9999" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["US"] } } }, "NationalIdentificationDK": { "type": "object", "description": "Danish Personal Identification Number (\"Det Centrale Personregister - CPR\")", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "Personal Identification Number in 10 digit format (DDMMYY-SSSS)", "pattern": "^[0-9]{6}-[0-9]{4}$", "example": "010212-0566" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["DK"] } } }, "NationalIdentificationES": { "type": "object", "description": "Spanish National Identity Document (Documento Nacional de Identidad - DNI)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "National Identity Document 9 digit format (SSSSSSSSA)", "pattern": "^[0-9]{8}[A-Z]{1}$", "example": "12345678Z" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["ES"] } } }, "NationalIdentificationFI": { "type": "object", "description": "Finnish Personal Identity Code (Henkilötunnus - HETU)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "Personal Identity Code in 11 digit format (DDMMYYCZZZQ)", "pattern": "^[0-9]{6}[A+-][0-9]{3}[0-9A-Z]{1}$", "example": "190122-829F" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["FI"] } } }, "NationalIdentificationIT": { "type": "object", "description": "Italian Fiscal Code (Codice Fiscale - CF)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "Fiscal Code in 16 digit format (LLLLLLYYMMDDSSSC)", "pattern": "^[0-9A-Z]{6}[0-9]{2}[ABCDEHLMPRST]{1}[0-9]{2}[A-Z]{1}[0-9]{3}[A-Z]{1}$", "example": "MRTMTT25D09F205Z" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["IT"] } } }, "NationalIdentificationNO": { "type": "object", "description": "Norwegian National Identity Number (Fødselsnummer - NIN)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "National Identity Number in 11 digit format (DDMMYYIIIKK)", "pattern": "^[0-9]{6}[0-9]{5}$", "example": "01021205667" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["NO"] } } }, "NationalIdentificationSE": { "type": "object", "description": "Swedish Personal Identity Number (\"Personnummer\" - PNO)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "Personal Identity Number in 12 digit format (YYYYMMDD-SSSS)", "pattern": "^[0-9]{8}-[0-9]{4}$", "example": "19811218-9876" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["SE"] } } }, "NationalIdentification": { "type": "object", "description": "Provide the person's national identification details to support identity verification and regulatory compliance.\nEnsure the object includes all required attributes and follows the format defined by the applicable national authority.\n", "x-validation-info": "Check that is an object", "oneOf": [{ "$ref": "#/components/schemas/NationalIdentificationUS" }, { "$ref": "#/components/schemas/NationalIdentificationDK" }, { "$ref": "#/components/schemas/NationalIdentificationES" }, { "$ref": "#/components/schemas/NationalIdentificationFI" }, { "$ref": "#/components/schemas/NationalIdentificationIT" }, { "$ref": "#/components/schemas/NationalIdentificationNO" }, { "$ref": "#/components/schemas/NationalIdentificationSE" }], "required": ["country", "number"], "discriminator": { "propertyName": "country", "mapping": { "US": "#/components/schemas/NationalIdentificationUS", "DK": "#/components/schemas/NationalIdentificationDK", "ES": "#/components/schemas/NationalIdentificationES", "FI": "#/components/schemas/NationalIdentificationFI", "IT": "#/components/schemas/NationalIdentificationIT", "NO": "#/components/schemas/NationalIdentificationNO", "SE": "#/components/schemas/NationalIdentificationSE" } } }, "SDKToken": { "type": "string", "minLength": 1, "maxLength": 8192, "description": "

Early ReleaseFeature under development, may not be fully available and is subject to change as we continue building the service in partnership with early users

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

The SDK token can be used when initializing Web SDK or Mobile SDK in order to personalize customer experience.\n", "example": "hbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9zaG9wcGluZ19zZXNzaW9uX2lkIjoia3JuOnNob3BwaW5nOmV1MTpzZ" }, "SDKTokenResponse": { "type": "object", "description": "The response object for the SDK token.\n", "additionalProperties": false, "properties": { "sdk_token": { "$ref": "#/components/schemas/SDKToken" } } }, "IdentityRequestId": { "type": "string", "example": "krn:partner:eu1:test:identity:request:0daf4df6-00b2-48cc-9165-c425cfcb36fe", "minLength": 1, "maxLength": 255, "description": "The unique identifier for the identity request.\nThis is the identifier you will use to reference the identity request in subsequent API calls.\n\nYou should not make any assumption about the format of this identifier, you should treat it as an opaque string.\n" }, "IdentityRequestState": { "type": "string", "description": "The current state of the Identity Request.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `SUBMITTED` | The identity request has been submitted to Klarna. |\n| `IN_PROGRESS` | The identity request is in progress. |\n| `COMPLETED` | The identity request has been completed (final state). |\n| `CANCELED` | The identity request has been cancelled (final state). |\n| `EXPIRED` | The identity request has expired (final state). |\n| `DECLINED` | The identity request has been declined (final state). |\n", "enum": ["SUBMITTED", "IN_PROGRESS", "COMPLETED", "CANCELED", "EXPIRED", "DECLINED"] }, "identity.request.state-change.submitted": { "type": "object", "description": "`SUBMITTED` is the initial state of an identity request.\n", "properties": { "identity_request_id": { "$ref": "#/components/schemas/IdentityRequestId" }, "state": { "$ref": "#/components/schemas/IdentityRequestState" }, "previous_state": { "$ref": "#/components/schemas/IdentityRequestState" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiry time of the identity request.\n\nAfter this timestamp the identity request will be deleted.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "required": ["identity_request_id", "state", "updated_at", "created_at", "expires_at"] }, "identity.request.state-change.in-progress": { "type": "object", "description": "The identity request is in progress. The customer has entered the identity verification flow.\n", "properties": { "identity_request_id": { "$ref": "#/components/schemas/IdentityRequestId" }, "state": { "$ref": "#/components/schemas/IdentityRequestState" }, "previous_state": { "$ref": "#/components/schemas/IdentityRequestState" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiry time of the identity request.\n\nAfter this timestamp the identity request will be deleted.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "required": ["identity_request_id", "state", "updated_at", "created_at", "expires_at"] }, "identity.request.state-change.completed": { "type": "object", "description": "The identity request has been completed. The customer has been successfully identified.\n", "properties": { "identity_request_id": { "$ref": "#/components/schemas/IdentityRequestId" }, "state": { "$ref": "#/components/schemas/IdentityRequestState" }, "previous_state": { "$ref": "#/components/schemas/IdentityRequestState" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiry time of the identity request.\n\nAfter this timestamp the identity request will be deleted.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "state_context": { "description": "State-specific context for the `COMPLETED` state. Present when identity data is\navailable (customer profile, customer token, network session token). May be absent\nin edge cases where the session completed without persona data (e.g. a data-only\ncompletion path that did not collect a full profile).\n", "type": "object", "properties": { "klarna_customer": { "type": "object", "description": "The identified Klarna customer associated with this completed identity request,\nincluding the customer profile and customer token. Persist the customer token in\nyour system associated with the customer account so you can act on behalf of the\ncustomer in subsequent Klarna interactions.\n", "properties": { "customer_profile": { "type": "object", "description": "Details of the Klarna customer account that has been identified.\n", "properties": { "customer_id": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Unique identifier of Klarna Customer account.", "example": "krn:kuid:vxsqIkCHf5lCWmaZ2beqwz" }, "given_name": { "$ref": "#/components/schemas/GivenName" }, "family_name": { "$ref": "#/components/schemas/FamilyName" }, "name_verified": { "description": "Indicates whether the customer's name has been verified by Klarna.\n", "type": "boolean" }, "email": { "$ref": "#/components/schemas/Email" }, "phone": { "$ref": "#/components/schemas/Phone" }, "phone_verified": { "description": "Indicates whether the phone number has been verified through OTP or not.\n", "type": "boolean" }, "email_verified": { "description": "Indicates whether the email address has been verified through OTP or not.\n", "type": "boolean" }, "country": { "$ref": "#/components/schemas/Country" }, "address": { "$ref": "#/components/schemas/CustomerAddress" }, "locale": { "$ref": "#/components/schemas/Locale" }, "date_of_birth": { "$ref": "#/components/schemas/DateOfBirth" }, "date_of_birth_verified": { "description": "Indicates whether the customer's date of birth has been verified by Klarna.\n", "type": "boolean" }, "national_identification": { "$ref": "#/components/schemas/NationalIdentification" } } }, "customer_token": { "type": "string", "description": "The customer token represents the tokenized customer and allows you to act\non behalf of the customer. You must persist this token in your system associated with the customer\naccount. To de-duplicate customers, you should use the `customer_id` as the unique identifier.\n", "maxLength": 1024, "minLength": 1, "example": "krn:partner:us1:live:identity:customer-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a", "x-validation-info": "Validation on the length (max length 1024) and the format of the string." }, "customer_token_reference": { "$ref": "#/components/schemas/CustomerTokenReference" } } }, "klarna_network_session_token": { "type": "string", "maxLength": 8192, "minLength": 1, "x-validation-info": "String between 1 and 8192 characters representing a Klarna network session token", "description": "A short-lived Klarna Network session token associated with this identification.\nUse this token to link subsequent Klarna interactions (payments, sign-in with Klarna, on-site messaging, express checkout, and prequalification) to the same network session.\nThis token expires and must not be cached long-term.\n", "example": "krn:network:eu1:live:session-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a" } } } }, "required": ["identity_request_id", "state", "updated_at", "created_at", "expires_at"] }, "identity.request.state-change.canceled": { "type": "object", "description": "The identity request has been canceled.\n", "properties": { "identity_request_id": { "$ref": "#/components/schemas/IdentityRequestId" }, "state": { "$ref": "#/components/schemas/IdentityRequestState" }, "previous_state": { "$ref": "#/components/schemas/IdentityRequestState" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiry time of the identity request.\n\nAfter this timestamp the identity request will be deleted.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "required": ["identity_request_id", "state", "updated_at", "created_at", "expires_at"] }, "identity.request.state-change.expired": { "type": "object", "description": "The identity request has expired.\n", "properties": { "identity_request_id": { "$ref": "#/components/schemas/IdentityRequestId" }, "state": { "$ref": "#/components/schemas/IdentityRequestState" }, "previous_state": { "$ref": "#/components/schemas/IdentityRequestState" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiry time of the identity request.\n\nAfter this timestamp the identity request will be deleted.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "required": ["identity_request_id", "state", "updated_at", "created_at", "expires_at"] }, "identity.request.state-change.declined": { "type": "object", "description": "The identity request has been declined.\n", "properties": { "identity_request_id": { "$ref": "#/components/schemas/IdentityRequestId" }, "state": { "$ref": "#/components/schemas/IdentityRequestState" }, "previous_state": { "$ref": "#/components/schemas/IdentityRequestState" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiry time of the identity request.\n\nAfter this timestamp the identity request will be deleted.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the identity request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "required": ["identity_request_id", "state", "updated_at", "created_at", "expires_at"] }, "identity.request.state-change": { "type": "object", "description": "Triggered when an identity request transitions to a new state. Use this webhook to track\nthe request lifecycle and take action on terminal outcomes such as `COMPLETED` or `DECLINED`.\nSee the `payload.state` discriminator for the per-state schema.\n\nThis webhook fires for the following state transitions: `SUBMITTED`, `IN_PROGRESS`,\n`COMPLETED`, `CANCELED`, `EXPIRED`, and `DECLINED`.\n", "properties": { "metadata": { "$ref": "#/components/schemas/WebhookMetadata" }, "payload": { "description": "The payload of the identity request state change webhook.\n", "anyOf": [{ "$ref": "#/components/schemas/identity.request.state-change.submitted" }, { "$ref": "#/components/schemas/identity.request.state-change.in-progress" }, { "$ref": "#/components/schemas/identity.request.state-change.completed" }, { "$ref": "#/components/schemas/identity.request.state-change.canceled" }, { "$ref": "#/components/schemas/identity.request.state-change.expired" }, { "$ref": "#/components/schemas/identity.request.state-change.declined" }], "discriminator": { "propertyName": "state", "mapping": { "SUBMITTED": "#/components/schemas/identity.request.state-change.submitted", "IN_PROGRESS": "#/components/schemas/identity.request.state-change.in-progress", "COMPLETED": "#/components/schemas/identity.request.state-change.completed", "CANCELED": "#/components/schemas/identity.request.state-change.canceled", "EXPIRED": "#/components/schemas/identity.request.state-change.expired", "DECLINED": "#/components/schemas/identity.request.state-change.declined" } } } } }, "ResourceErrorCustomerTokenRevoked": { "type": "object", "description": "The customer token referenced by the resource has been revoked.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "CUSTOMER_TOKEN_REVOKED" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "RESOURCE_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Resource customer token has been revoked" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "ResourceErrorNotFoundError": { "type": "object", "description": "The requested resource was not found.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "RESOURCE_NOT_FOUND" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "RESOURCE_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Resource does not exist" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "AccessErrorRateLimited": { "type": "object", "description": "The request was rate limited.\n\nAll requests from this client are temporarily rate limited.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "RATE_LIMITED" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "ACCESS_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Too many requests - please try again later" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "AccessErrorUnauthorized": { "type": "object", "description": "The presented credentials failed authentication.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "UNAUTHORIZED" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "ACCESS_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "The presented credentials failed authentication" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "InputErrorContentTypeError": { "type": "object", "description": "The input does not conform to the expected content type syntax. For example invalid JSON.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "INVALID_CONTENT_TYPE" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "INPUT_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "The received input is not valid JSON" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "InputErrorValidationError": { "type": "object", "description": "An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "VALIDATION_ERROR" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "INPUT_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048 }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 }, "validation_errors": { "type": "array", "description": "A list of validation errors that occurred\n", "maxItems": 100, "items": { "type": "object", "description": "A validation error that occurred on a specific parameter.\n", "required": ["parameter", "reason"], "properties": { "parameter": { "type": "string", "minLength": 0, "maxLength": 256, "description": "The name of the parameter that caused the error.\nSpecified in JSON dot-notation syntax.\n" }, "reason": { "type": "string", "minLength": 0, "maxLength": 512, "description": "A human readable error message describing the error.\n" }, "doc_url": { "type": "string", "minLength": 0, "maxLength": 2048, "description": "A deep link to the relevant documentation page on klarna.docs on how to fix the error.\n", "format": "uri" } } } } } }, "ResourceErrorOperationForbidden": { "type": "object", "description": "Insufficient privileges to perform the requested operation on the resource.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "OPERATION_FORBIDDEN" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "RESOURCE_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Insufficient privileges to on resource " }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "TechnicalErrorInternalError": { "type": "object", "description": "An unexpected error occurred in the API.\n\nThe request may be retried without modification after a delay.\n\nIf this error persists, please reach out to your Klarna support contact.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "INTERNAL_ERROR" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "TECHNICAL_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Something went wrong at Klarna, if the error persists please reach out to your support contact and include this message" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "TechnicalErrorTemporaryUnavailable": { "type": "object", "description": "The system is temporarily unavailable to process the request.\n\nThe request may be retried without modification after a delay.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "TEMPORARY_UNAVAILABLE" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "TECHNICAL_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "The system is temporarily unavailable to process the request" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "TechnicalErrorTimeout": { "type": "object", "description": "The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.\n\nThe request may be retried without modification after a delay.\n\nIf this error persists, please reach out to your Klarna support contact.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "TIMEOUT" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "TECHNICAL_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "The request timed out. Please retry after a short delay." }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } } }, "responses": { "NotFound": { "description": "Resource customer token does not exist.", "content": { "application/json": { "examples": { "Resource customer token does not exist": { "value": { "error_id": "1653c9db-454b-4222-8265-4c7ca209f630", "error_code": "RESOURCE_NOT_FOUND", "error_type": "RESOURCE_ERROR", "error_message": "Resource customer token does not exist" } } } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } } }, "parameters": {}, "headers": { "KlarnaCorrelationId": { "description": "UUID v4 that uniquely identifies the request.", "schema": { "type": "string", "format": "uuid", "minLength": 0, "maxLength": 36 } }, "PartnerCorrelationIdResponse": { "description": "An echo of the Partner-Correlation-Id header that was sent with the request.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "examples": { "Customer_token_instrospection_response_for_active_customer_present": { "value": { "status": "ACTIVE", "scopes": ["payment:customer_present", "customer:login"], "issued_at": 1723791546323, "customer_token_reference": "partner_customer_token_1234" } }, "Customer_token_instrospection_response_for_revoked_customer_present": { "value": { "status": "REVOKED", "scopes": ["payment:customer_present", "customer:login"], "issued_at": 1723791546323, "customer_token_reference": "partner_customer_token_1234" } }, "Customer_token_revocation_response": { "value": { "customer_token_reference": "partner_customer_token_1234" } }, "Identity_customer_token_revoked_webhook": { "value": { "metadata": { "event_type": "identity.customer-token.state-change.revoked", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-12T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "customer_token": "krn:partner:us1:live:identity:customer-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a", "customer_token_reference": "partner-token-reference-1234" } } }, "Identity_request_submitted_webhook": { "description": "The identity request has been submitted to Klarna.\n", "value": { "metadata": { "event_type": "identity.request.state-change.submitted", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-12T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "identity_request_id": "krn:partner:eu1:live:identity:request:0daf4df6-00b2-48cc-9165-c425cfcb36fe", "state": "SUBMITTED", "created_at": "2024-01-12T13:00:00Z", "expires_at": "2024-01-13T13:00:00Z", "updated_at": "2024-01-12T13:00:00Z" } } }, "Identity_request_in-progress_webhook": { "description": "The identity request is in progress. The customer has entered the identity verification flow.\n", "value": { "metadata": { "event_type": "identity.request.state-change.in-progress", "event_id": "a3c21f74-88b5-4d12-b6e7-f891234567ab", "event_version": "v2", "occurred_at": "2024-01-12T13:05:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "identity_request_id": "krn:partner:eu1:live:identity:request:0daf4df6-00b2-48cc-9165-c425cfcb36fe", "state": "IN_PROGRESS", "previous_state": "SUBMITTED", "created_at": "2024-01-12T13:00:00Z", "expires_at": "2024-01-13T13:00:00Z", "updated_at": "2024-01-12T13:05:00Z" } } }, "Identity_request_completed_webhook": { "description": "The identity request has been completed. The customer has been successfully identified.\n", "value": { "metadata": { "event_type": "identity.request.state-change.completed", "event_id": "b9d45e32-1a2b-4c3d-9e8f-0123456789cd", "event_version": "v2", "occurred_at": "2024-01-12T13:10:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "identity_request_id": "krn:partner:eu1:live:identity:request:0daf4df6-00b2-48cc-9165-c425cfcb36fe", "state": "COMPLETED", "previous_state": "IN_PROGRESS", "created_at": "2024-01-12T13:00:00Z", "expires_at": "2024-01-13T13:00:00Z", "updated_at": "2024-01-12T13:10:00Z", "state_context": { "klarna_customer": { "customer_profile": { "customer_id": "krn:kuid:vxsqIkCHf5lCWmaZ2beqwz", "given_name": "Klara", "family_name": "Angel", "name_verified": true, "email": "klara.angel@klarna.com", "email_verified": true, "phone": "+18445527621", "phone_verified": true, "country": "US", "locale": "en-US", "date_of_birth": "1985-07-14", "date_of_birth_verified": true, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "US-OH", "country": "US" } }, "customer_token": "krn:partner:eu1:live:identity:customer-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a", "customer_token_reference": "partner-token-reference-1234" }, "klarna_network_session_token": "krn:network:eu1:live:session-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" } } } }, "Identity_request_canceled_webhook": { "description": "The identity request has been canceled.\n", "value": { "metadata": { "event_type": "identity.request.state-change.canceled", "event_id": "d2f78a90-3c4d-6e5f-b001-234567890abc", "event_version": "v2", "occurred_at": "2024-01-12T13:07:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "identity_request_id": "krn:partner:eu1:live:identity:request:0daf4df6-00b2-48cc-9165-c425cfcb36fe", "state": "CANCELED", "previous_state": "IN_PROGRESS", "created_at": "2024-01-12T13:00:00Z", "expires_at": "2024-01-13T13:00:00Z", "updated_at": "2024-01-12T13:07:00Z" } } }, "Identity_request_expired_webhook": { "description": "The identity request has expired.\n", "value": { "metadata": { "event_type": "identity.request.state-change.expired", "event_id": "e3081ba1-4d5e-7f60-c112-34567890bcde", "event_version": "v2", "occurred_at": "2024-01-13T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "identity_request_id": "krn:partner:eu1:live:identity:request:0daf4df6-00b2-48cc-9165-c425cfcb36fe", "state": "EXPIRED", "previous_state": "IN_PROGRESS", "created_at": "2024-01-12T13:00:00Z", "expires_at": "2024-01-13T13:00:00Z", "updated_at": "2024-01-13T13:00:00Z" } } }, "Identity_request_declined_webhook": { "description": "The identity request has been declined.\n", "value": { "metadata": { "event_type": "identity.request.state-change.declined", "event_id": "c1e67f89-2b3c-5d4e-af90-1234567890ef", "event_version": "v2", "occurred_at": "2024-01-12T13:08:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "identity_request_id": "krn:partner:eu1:live:identity:request:0daf4df6-00b2-48cc-9165-c425cfcb36fe", "state": "DECLINED", "previous_state": "IN_PROGRESS", "created_at": "2024-01-12T13:00:00Z", "expires_at": "2024-01-13T13:00:00Z", "updated_at": "2024-01-12T13:08:00Z" } } } } }, "servers": [{ "url": "https://api-global.klarna.com", "description": "Production environment" }, { "url": "https://api-global.test.klarna.com", "description": "Test environment" }], "tags": [], "webhooks": { "identity.request.state-change": { "post": { "tags": ["Identity Request API"], "summary": "Webhook: Identity request state change", "description": "Klarna delivers this webhook when an identity request transitions to a new state.\nRespond with HTTP 200 to acknowledge receipt. If no acknowledgement is received\nKlarna will retry delivery.\n", "operationId": "identityRequestStateChangeWebhook", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.request.state-change" }, "examples": { "Identity request submitted webhook": { "$ref": "#/components/examples/Identity_request_submitted_webhook" }, "Identity request in-progress webhook": { "$ref": "#/components/examples/Identity_request_in-progress_webhook" }, "Identity request completed webhook": { "$ref": "#/components/examples/Identity_request_completed_webhook" }, "Identity request canceled webhook": { "$ref": "#/components/examples/Identity_request_canceled_webhook" }, "Identity request expired webhook": { "$ref": "#/components/examples/Identity_request_expired_webhook" }, "Identity request declined webhook": { "$ref": "#/components/examples/Identity_request_declined_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } } } } } } }; function _createMdxContent(props) { const {ApiSpecs} = { ..._provideComponents(), ...props.components }; if (!ApiSpecs) _missingMdxReference("ApiSpecs", true); return _jsx(ApiSpecs, { ...apiSpecs }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = { ..._provideComponents(), ...props.components }; return MDXLayout ? _jsx(MDXLayout, { ...props, children: _jsx(_createMdxContent, { ...props }) }) : _createMdxContent(props); } return { apiSpecs, default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }