v2 (r9)

The request contained a validation error.


Bad Request, the request contained a validation error or the input did not conform to the expected content type syntax.


Bad Request, there was an error in the input of the request.
The request can not be retried without modifications.


Resource customer token has been revoked.

Unauthorized access to the resource customer token.

Internal Server Error, there was an unexpected error in the API.


Too Many Requests, the request was rate limited.


Service Temporarily Unavailable, the system is temporarily unavailable to process the request.


Unauthorized, the request was not authorized.


The request was rate limited.

All requests from this client are temporarily rate limited.


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.


A human readable error message describing the error.


The presented credentials failed authentication.


Unique account identifier assigned by Klarna to the onboarded merchant

Returned if Account Linking or payment tokenization was requested.

The customer token represents the tokenized customer and allows you to act
on behalf of the customer. You must persist this token in your system associated with the customer
account. To de-duplicate customers, you should use the `customer_id` as the unique identifier.


Partner reference to the customer token created on Klarna side.
This 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.


The input does not conform to the expected content type syntax. For example invalid JSON.


An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.


A list of validation errors that occurred


A validation error that occurred on a specific parameter.


A deep link to the relevant documentation page on klarna.docs on how to fix the error.


The name of the parameter that caused the error.
Specified in JSON dot-notation syntax.


Payload parameter utilized in the Identity API for revoking legacy One Klarna Tokens (purchase tokens).

The One Klarna Token represents a customer's consent, allowing a merchant to charge their Klarna account
or enabling Klarna to charge the customer's payment method or funding source without the customer being
physically present.


The SDK token can be used when initializing Web SDK or Mobile SDK in order to personalize customer experience.


An unexpected error occurred in the API.

The request may be retried without modification after a delay.

If this error persists, please reach out to your Klarna support contact.


The system is temporarily unavailable to process the request.

The request may be retried without modification after a delay.


HMAC-SHA256 signature over the HTTP request body signed with the key identified by `Klarna-Signing-Key-ID`. 

The signature is calculated over the full HTTP request body.

  `computedHexDigest = HMAC_SHA256_HexDigest(request.body, getSecretKey(request.headers["Klarna-Signing-Key-ID"]))`

Compare the computed signature with the value of the `Klarna-Signature` header. If they match, the request is coming
from Klarna and you can process the webhook. If they do not match, you should reject the request.


The unique identifier of the delivered event.

A boolean flag indicating whether the event is generated in a production environment.

The timestamp when the event occurred. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z


The unique identifier of the product instance.

The unique identifier of the account that has configured the webhook and receives the notification.

The unique identifier of the account for which the event has occurred.

The unique identifier of the webhook that triggered the notification.

The common payload of a customer token revocation event.


The payload of the customer token revocation event.


Use the Klarna API key as HTTP Basic Authentication credentials

Authorization

Klarna Partner Product API - Identity

<div data-badge-container><div id="custom-meta-attributes" data-is-operation="true"><span class="tooltip-container"><a href="https://docs.klarna.com/api/kn/versioning-release-management/#service-lifecycle-stage" target="_blank" data-lifecycle-stage="early-release"><span>Early Release</span><svg aria-hidden="true" role="img" viewBox="0 0 20 20" height="14" width="14"><g fill="none" fill-rule="evenodd" transform="translate(0, 0) scale(1)"><path d="M16.828 3.172c-1.788-1.79-3.986-2-5.463-.522L9.508 4.508l1.178 1.178 1.858-1.857c1.202-1.2 2.681.096 3.106.522.426.425 1.72 1.907.522 3.106l-3.916 3.916c-1.2 1.197-2.68-.096-3.106-.522a4.312 4.312 0 0 1-.566-.706l-1.201 1.201c.175.233.368.462.589.683.995.995 2.114 1.502 3.167 1.502.841 0 1.639-.324 2.296-.98l3.916-3.916c1.477-1.478 1.267-3.673-.523-5.463Zm-9.372 13c-1.197 1.199-2.68-.096-3.106-.521-.425-.426-1.72-1.908-.522-3.107l3.916-3.916c.384-.383.834-.544 1.342-.48.572.073 1.182.42 1.764 1.002.231.232.41.468.566.706l1.201-1.201a6.29 6.29 0 0 0-.589-.683c-.845-.846-1.789-1.357-2.73-1.477-1.016-.13-1.987.21-2.732.955L2.65 11.366c-1.478 1.478-1.268 3.673.522 5.463.995.995 2.115 1.502 3.167 1.502.841 0 1.64-.324 2.296-.98l1.857-1.858-1.178-1.179-1.858 1.858Z" fill="rgba(11, 5, 29, 1)" style="transition: fill 0.2s;"></path></g></svg></a><span class="custom-tooltip">Feature under development, may not be fully available and is subject to change as we continue building the service in partnership with early users</span></span></div><div id="custom-meta-attributes"><span class="tooltip-container"><span data-intended-for-badge><span>Acquiring Partner</span></span><span class="custom-tooltip">Acquiring Partners integrate Klarna’s payment solutions into their own platforms or services, enabling their connected Partners to offer Klarna to end customers.</span></span></div></div><p>Introspect a customer token issued in the account linking flow to obtain more information regarding the token.</p><hr style='height:0.2px;border-width:0;color:gray;background-color:gray'/>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    Operation ID:
                    <span class="custom-tooltip">A unique identifier for the operation.</span>
                </span>
                <span class="tooltip-container"> tokenIntrospect</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/klarna-network-service-level/#slo-categories">SLO Category</a>:
                    <span class="custom-tooltip">The SLO Service Category.</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Operations that provide read access to verify if a customer has an existing Klarna account or to retrieve details from an account linking token.</span>Read-Only Identity</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/klarna-network-service-level/#sla-service-class">SLA Service Class</a>:
                    <span class="custom-tooltip">The SLA Service Class this operation is classified at when evaluating SLA compliance.</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Operations, webhooks and other services that does not directly impact the core purchasing process in real-time and enables supplemental or secondary features</span>Tier 2 Services</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/versioning-release-management/#availability">Availability in Test environment</a>:
                    <span class="custom-tooltip">Indicates if the feature is available in the Klarna Test environment</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Feature is available in the Klarna Test environment</span>Available</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/versioning-release-management/#availability">Availability in Production environment</a>:
                    <span class="custom-tooltip">Indicates if the feature is available in the Klarna Production environment</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Feature is available in the Klarna Production environment</span>Available</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/rate-limiting/#api-operation-categories">Ratelimit Category</a>:
                    <span class="custom-tooltip">The Ratelimit Category.</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Operations used to manage partner accounts and additional partner operations that are not related to onboarding.</span>Partner Management</span>
              </div>

The unique identifier of the account for which the action is performed.

partner_account_id

Klarna-Customer-Token

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)

The header value as appearing on the wire should be a JSON object string literal without newlines as produced by `JSON.stringify()`.

Example: `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"}]}`

Klarna-Integration-Metadata

Partner-Correlation-Id

An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response.

Introspect a customer token issued in the account linking flow.


Webhook notification delivered when a customer token has been successfully revoked on Klarna's side.

<div data-badge-container><div id="custom-meta-attributes" data-is-operation="true"><span class="tooltip-container"><a href="https://docs.klarna.com/api/kn/versioning-release-management/#service-lifecycle-stage" target="_blank" data-lifecycle-stage="early-release"><span>Early Release</span><svg aria-hidden="true" role="img" viewBox="0 0 20 20" height="14" width="14"><g fill="none" fill-rule="evenodd" transform="translate(0, 0) scale(1)"><path d="M16.828 3.172c-1.788-1.79-3.986-2-5.463-.522L9.508 4.508l1.178 1.178 1.858-1.857c1.202-1.2 2.681.096 3.106.522.426.425 1.72 1.907.522 3.106l-3.916 3.916c-1.2 1.197-2.68-.096-3.106-.522a4.312 4.312 0 0 1-.566-.706l-1.201 1.201c.175.233.368.462.589.683.995.995 2.114 1.502 3.167 1.502.841 0 1.639-.324 2.296-.98l3.916-3.916c1.477-1.478 1.267-3.673-.523-5.463Zm-9.372 13c-1.197 1.199-2.68-.096-3.106-.521-.425-.426-1.72-1.908-.522-3.107l3.916-3.916c.384-.383.834-.544 1.342-.48.572.073 1.182.42 1.764 1.002.231.232.41.468.566.706l1.201-1.201a6.29 6.29 0 0 0-.589-.683c-.845-.846-1.789-1.357-2.73-1.477-1.016-.13-1.987.21-2.732.955L2.65 11.366c-1.478 1.478-1.268 3.673.522 5.463.995.995 2.115 1.502 3.167 1.502.841 0 1.64-.324 2.296-.98l1.857-1.858-1.178-1.179-1.858 1.858Z" fill="rgba(11, 5, 29, 1)" style="transition: fill 0.2s;"></path></g></svg></a><span class="custom-tooltip">Feature under development, may not be fully available and is subject to change as we continue building the service in partnership with early users</span></span></div><div id="custom-meta-attributes"><span class="tooltip-container"><span data-intended-for-badge><span>Acquiring Partner</span></span><span class="custom-tooltip">Acquiring Partners integrate Klarna’s payment solutions into their own platforms or services, enabling their connected Partners to offer Klarna to end customers.</span></span></div></div><p>Revoke a customer token issued in the account linking flow, so that any subsequent payment requests using the token are rejected.</p><hr style='height:0.2px;border-width:0;color:gray;background-color:gray'/>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    Operation ID:
                    <span class="custom-tooltip">A unique identifier for the operation.</span>
                </span>
                <span class="tooltip-container"> tokenRevoke</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/klarna-network-service-level/#slo-categories">SLO Category</a>:
                    <span class="custom-tooltip">The SLO Service Category.</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Operations that allow the revocation or updates of a customer token issued during the account linking process.</span>Identity</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/klarna-network-service-level/#sla-service-class">SLA Service Class</a>:
                    <span class="custom-tooltip">The SLA Service Class this operation is classified at when evaluating SLA compliance.</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Operations, webhooks and other services that does not directly impact the core purchasing process in real-time and enables supplemental or secondary features</span>Tier 2 Services</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/versioning-release-management/#availability">Availability in Test environment</a>:
                    <span class="custom-tooltip">Indicates if the feature is available in the Klarna Test environment</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Feature is available in the Klarna Test environment</span>Available</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/versioning-release-management/#availability">Availability in Production environment</a>:
                    <span class="custom-tooltip">Indicates if the feature is available in the Klarna Production environment</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Feature is available in the Klarna Production environment</span>Available</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/rate-limiting/#api-operation-categories">Ratelimit Category</a>:
                    <span class="custom-tooltip">The Ratelimit Category.</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Operations used to manage partner accounts and additional partner operations that are not related to onboarding.</span>Partner Management</span>
              </div>

Revoke a customer token issued in the account linking flow.


<div data-badge-container><div id="custom-meta-attributes" data-is-operation="true"><span class="tooltip-container"><a href="https://docs.klarna.com/api/kn/versioning-release-management/#service-lifecycle-stage" target="_blank" data-lifecycle-stage="early-release"><span>Early Release</span><svg aria-hidden="true" role="img" viewBox="0 0 20 20" height="14" width="14"><g fill="none" fill-rule="evenodd" transform="translate(0, 0) scale(1)"><path d="M16.828 3.172c-1.788-1.79-3.986-2-5.463-.522L9.508 4.508l1.178 1.178 1.858-1.857c1.202-1.2 2.681.096 3.106.522.426.425 1.72 1.907.522 3.106l-3.916 3.916c-1.2 1.197-2.68-.096-3.106-.522a4.312 4.312 0 0 1-.566-.706l-1.201 1.201c.175.233.368.462.589.683.995.995 2.114 1.502 3.167 1.502.841 0 1.639-.324 2.296-.98l3.916-3.916c1.477-1.478 1.267-3.673-.523-5.463Zm-9.372 13c-1.197 1.199-2.68-.096-3.106-.521-.425-.426-1.72-1.908-.522-3.107l3.916-3.916c.384-.383.834-.544 1.342-.48.572.073 1.182.42 1.764 1.002.231.232.41.468.566.706l1.201-1.201a6.29 6.29 0 0 0-.589-.683c-.845-.846-1.789-1.357-2.73-1.477-1.016-.13-1.987.21-2.732.955L2.65 11.366c-1.478 1.478-1.268 3.673.522 5.463.995.995 2.115 1.502 3.167 1.502.841 0 1.64-.324 2.296-.98l1.857-1.858-1.178-1.179-1.858 1.858Z" fill="rgba(11, 5, 29, 1)" style="transition: fill 0.2s;"></path></g></svg></a><span class="custom-tooltip">Feature under development, may not be fully available and is subject to change as we continue building the service in partnership with early users</span></span></div><div id="custom-meta-attributes"><span class="tooltip-container"><span data-intended-for-badge><span>Acquiring Partner</span></span><span class="custom-tooltip">Acquiring Partners integrate Klarna’s payment solutions into their own platforms or services, enabling their connected Partners to offer Klarna to end customers.</span></span></div></div><p>Returns an sdk_token that can be used to initialize Web SDK or Mobile SDK in order to personalize customer experience.</p><hr style='height:0.2px;border-width:0;color:gray;background-color:gray'/>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    Operation ID:
                    <span class="custom-tooltip">A unique identifier for the operation.</span>
                </span>
                <span class="tooltip-container"> generateIdentitySdkToken</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/klarna-network-service-level/#slo-categories">SLO Category</a>:
                    <span class="custom-tooltip">The SLO Service Category.</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Operations that provide read access to verify if a customer has an existing Klarna account or to retrieve details from an account linking token.</span>Read-Only Identity</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/klarna-network-service-level/#sla-service-class">SLA Service Class</a>:
                    <span class="custom-tooltip">The SLA Service Class this operation is classified at when evaluating SLA compliance.</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Operations, webhooks and other services that are outside the scope of both Tier 1 and Tier 2 Services</span>Tier 3 Services</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/versioning-release-management/#availability">Availability in Test environment</a>:
                    <span class="custom-tooltip">Indicates if the feature is available in the Klarna Test environment</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Feature is available in the Klarna Test environment</span>Available</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/versioning-release-management/#availability">Availability in Production environment</a>:
                    <span class="custom-tooltip">Indicates if the feature is available in the Klarna Production environment</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Feature is available in the Klarna Production environment</span>Available</span>
              </div>
              <div id="custom-meta-attributes">
                <span class="tooltip-container">
                    <a href="https://docs.klarna.com/api/kn/rate-limiting/#api-operation-categories">Ratelimit Category</a>:
                    <span class="custom-tooltip">The Ratelimit Category.</span>
                </span>
                <span class="tooltip-container"> <span class="custom-tooltip">Includes crucial actions for capturing payment transactions.</span>Payment Transaction Capture</span>
              </div>