---
updatedAt: 2026-04-28T18:31:13.000Z
agentTools:
  projectIndex: https://developer.trulioo.com/llms.txt
---

# Create a shortcode for handoff to a SDK

Short code provides an option to pass the rest of the verification workflow to an SDK. The short code is a unique, single use code and it is valid for only 5 minutes. The verification will continue on SDK side starting with authorization using the short code. The short code locks the workflow to the same transaction identifier as the one generated earlier during authorization.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Customer API",
    "version": "2.4",
    "description": "The Trulioo Customer API is organized around REST. Our API has predictable resource-oriented URLs and uses standard HTTP response codes, authentication, and verbs. The API provides authorization endpoints and endpoints to perform document verification and review transaction results.\n<br />\n> Some US states impose obligations on businesses that collect and use “biometric identifiers” and/or “biometric information”, which may include facial scan data extracted from photos during a document verification transaction. One such law is the Illinois Biometric Information Privacy Act (“BIPA”). A business required to comply with BIPA is under obligations to, among other things, ensure that it informs the individual of the purpose of the collection and obtain consent. Accordingly, we require a notice and consent mechanism be implemented for all document verification transactions, and our customers using our API must provide us with confirmation via API whether an individual is located in the United States and has consented to the transaction in the prescribed manner. We also strongly encourage all of our customers to consult with legal counsel to ensure their own compliance with such laws. <br />  <br /> For more information about the required notice and consent mechanism, please refer to our [Service Specific Terms](https://www.trulioo.com/legal/SST) for Document Verification. <br />  <br /> You can read more about the configuration requirements for our API related to the notice and consent mechanism [here](#tag/Audit/operation/post-customer-audit-record-consent)."
  },
  "servers": [
    {
      "url": "https://verification.trulioo.com",
      "description": "production"
    }
  ],
  "tags": [
    {
      "name": "Transaction"
    }
  ],
  "security": [
    {
      "AccessToken": []
    }
  ],
  "paths": {
    "/customer/handoff": {
      "post": {
        "tags": [
          "Transaction"
        ],
        "summary": "Create a shortcode for handoff to a SDK",
        "operationId": "post-handoff",
        "description": "Short code provides an option to pass the rest of the verification workflow to an SDK. The short code is a unique, single use code and it is valid for only 5 minutes. The verification will continue on SDK side starting with authorization using the short code. The short code locks the workflow to the same transaction identifier as the one generated earlier during authorization.",
        "parameters": [
          {
            "schema": {
              "type": "string"
            },
            "in": "header",
            "name": "Accept-Version",
            "description": "API Version",
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HandoffResponse"
                }
              }
            },
            "headers": {
              "Accept-Version": {
                "schema": {
                  "type": "string"
                },
                "description": "API Version"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "403": {
            "$ref": "#/components/responses/ForbiddenError"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "AccessToken": {
        "type": "http",
        "scheme": "bearer",
        "description": "JWT token of type access"
      }
    },
    "responses": {
      "UnauthorizedError": {
        "description": "Unauthorized \n \n `default`: Jwt is expired",
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "default": "Jwt is expired"
            }
          }
        }
      },
      "ForbiddenError": {
        "description": "Forbidden \n \n `default`: Access Denied",
        "headers": {
          "Accept-Version": {
            "schema": {
              "type": "string"
            },
            "description": "API Version of the response"
          }
        },
        "content": {
          "text/plain": {
            "schema": {
              "type": "string",
              "default": "Access Denied"
            }
          }
        }
      },
      "InternalError": {
        "description": "Internal Server Error",
        "headers": {
          "Accept-Version": {
            "schema": {
              "type": "string",
              "description": "API Version of the response"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string",
                  "default": "The server encountered an error. Please email us at support@trulioo.com."
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "HandoffResponse": {
        "title": "HandoffResponse",
        "type": "object",
        "properties": {
          "shortCode": {
            "type": "string",
            "description": "The single use unique identifier used for handoff the transaction to an SDK.",
            "example": "qWinHpfejeezSqek"
          }
        }
      }
    }
  }
}
```