> ## Documentation Index > Fetch the complete documentation index at: https://docs.imprint.co/llms.txt > Use this file to discover all available pages before exploring further. # Create a new customer session > Creates a new session for a customer with a client_secret that can be passed to the SDK, providing client access to modify their own profile, card, or card/loan application. If required, a new customer will be created to attach this session to. Customer history can be attached to this session and will be included in the customer's profile if created, or attached to the application the customer creates during the session ## OpenAPI ````yaml /api-reference/2025-05-05/openapi.yaml post /v2/customer_sessions openapi: 3.1.0 info: title: Public Imprint API version: '2.0' servers: - url: https://dev.sbx.imprint.co description: Imprint public api sandbox security: - basicAuth: [] - bearerAuth: [] paths: /v2/customer_sessions: post: tags: - Customer Sessions summary: Create a new customer session description: >- Creates a new session for a customer with a client_secret that can be passed to the SDK, providing client access to modify their own profile, card, or card/loan application. If required, a new customer will be created to attach this session to. Customer history can be attached to this session and will be included in the customer's profile if created, or attached to the application the customer creates during the session operationId: createSession requestBody: content: application/json: schema: type: object properties: partner_customer_id: $ref: '#/components/schemas/PartnerCustomerId' transaction_amount: type: integer description: >- The current transaction amount, if the session is currently executing a transaction. integer value in the min currency unit (cents for USD) example: 34000 transaction_currency: type: string description: The 3 char currency code of the amount in iso-4217 example: USD customer_history: $ref: '#/components/schemas/CustomerAccountHistory' source: type: string description: The marketing source that referred the customer. example: web_signup utm_medium: type: string description: The marketing medium that referred the customer. example: cpc utm_channel: type: string description: The marketing channel that referred the customer. example: paid_social utm_campaign: type: string description: The marketing campaign that referred the customer. example: spring_card_launch utm_content: type: string description: >- The specific creative or placement that referred the customer. example: hero_banner_v2 utm_term: type: string description: The paid search keyword that referred the customer. example: rewards+credit+card utm_owner: type: string description: >- The team or owner accountable for the campaign that produced this session. example: growth application_origin: $ref: '#/components/schemas/ApplicationOrigin' origin_location_id: type: string description: >- Your own store or location code identifying where the application originated. example: STORE-4417 metadata: type: object description: Additional linking metadata additionalProperties: true example: store_number: '123' customer_metadata: type: object description: >- A set of key-value pairs attached to the customer. These values will be included in webhook event payloads for the partner to receive information about the customer. additionalProperties: type: string example: loyalty_id: '840012345678' membership_tier: gold responses: '201': description: Customer session created successfully content: application/json: schema: $ref: '#/components/schemas/CustomerSession' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/InvalidRequestError' components: schemas: PartnerCustomerId: type: string minLength: 1 maxLength: 128 pattern: ^[\x20-\x7E]+$ description: | The unique identifier for the customer in the partner's system. Compared byte-for-byte, so `PARTNER_USER_456` and `partner_user_456` are two different customers. Send the same casing everywhere or a later lookup silently returns no match. Restricted to printable ASCII (`\x20`–`\x7E`) rather than arbitrary UTF-8: the value is propagated between internal services as an HTTP/2 header, which cannot carry non-ASCII bytes. The bound is published rather than discovered. example: PARTNER_USER_456 CustomerAccountHistory: type: object description: A Customer's account history with the partner properties: email: type: string format: email description: Customer's email address example: customer@example.com phone: type: string description: Customer's phone number in E.164 format example: '+14155552671' first_name: type: string description: The customer's first name example: John last_name: type: string description: The customer's last name example: Doe preferred_language: type: string description: Customer's preferred language code as defined by ISO 639-1 example: en address: $ref: '#/components/schemas/Address' account_tenure: type: integer description: The customer's account tenure with the partner, in months example: 13 ltv_amount: type: integer description: >- The Life Time Value for the customer's account, in the min currency unit (cents for USD) example: 34000 ltv_currency: type: string description: The 3 char currency code of the amount in iso-4217 example: USD loyalty_tier: type: string description: The customer's current loyalty tier example: GOLD account_created_at: type: string description: >- The RFC-3339 timestamp when the customer's account was created with the partner example: '2025-02-13T19:08:07.000Z' transaction_count: type: integer description: >- The number of lifetime transactions the customer has made with the partner example: 100 ApplicationOrigin: type: string description: >- Where the application originated. Free-form, so campaign and channel origins can be introduced without an API change. In-store applications use one of `in_store_associate`, `in_store_kiosk`, or `in_store_signage`; a server-verified in-store application overrides whatever value you supply. example: in_store_kiosk CustomerSession: type: object description: Represents a session created on behalf of an Imprint customer required: - id - client_secret - expires_at properties: id: type: string example: 2EE24580-B97B-4949-A65C-929CCB9B9B8D description: The unique ID Imprint assigns to the session. client_secret: type: string example: QzMyNzg4QzgtNEUwOS00QkU4LThDMjEtMkU5OUQ3QzkwRDhGCg== description: >- Not to be logged or stored. Provide this one time use token to the Imprint SDK or other client side code to allow the customer access to edit their own account or apply expires_at: type: string description: the RFC-3339 timestamp when the `client_secret` will expire. example: '2025-02-13T19:08:07.000Z' metadata: type: object description: >- Set of key-value pairs for storing additional information about the customer session. additionalProperties: true example: store_number: '123' customer_metadata: type: object description: >- A set of key-value pairs attached to the customer. These values will be included in webhook event payloads for the partner to receive information about the customer. additionalProperties: type: string example: loyalty_id: '840012345678' membership_tier: gold source: type: string description: The marketing source that referred the customer. example: web_signup utm_medium: type: string description: The marketing medium that referred the customer. example: cpc utm_channel: type: string description: The marketing channel that referred the customer. example: paid_social utm_campaign: type: string description: The marketing campaign that referred the customer. example: spring_card_launch utm_content: type: string description: The specific creative or placement that referred the customer. example: hero_banner_v2 utm_term: type: string description: The paid search keyword that referred the customer. example: rewards+credit+card utm_owner: type: string description: >- The team or owner accountable for the campaign that produced this session. example: growth application_origin: $ref: '#/components/schemas/ApplicationOrigin' origin_location_id: type: string description: >- Your own store or location code identifying where the application originated. example: STORE-4417 partner_customer_id: $ref: '#/components/schemas/PartnerCustomerId' transaction_amount: type: integer format: int64 description: >- The current transaction amount, in the min currency unit (cents for USD) example: 34000 transaction_currency: type: string description: The 3 char currency code of the amount in iso-4217 example: USD customer_history: $ref: '#/components/schemas/CustomerAccountHistory' InvalidRequestError: type: object properties: path: type: string description: The path of the endpoint returning the error example: /v2/customers details: type: array items: type: string description: The details of the error being returned example: - 'email: must be a well-formed email address' error: type: string description: The category of error being returned example: Bad Request status: type: integer description: The HTTP status code of the error example: 400 timestamp: type: string description: The timestamp that the error occurred example: '2025-01-20T18:18:22.923+00:00' Address: type: object description: Mailing address information properties: street_line1: type: string description: Primary street address example: 123 Main St street_line2: type: string description: Secondary street address (apartment, suite, etc.) example: Apt 4B city: type: string description: City name example: San Francisco state: type: string description: State or province example: CA postal_code: type: string examples: - '94105' - 94105-1234 country: type: string description: ISO-3166-1 alpha-3 Country Code example: USA securitySchemes: basicAuth: type: http scheme: basic description: >- Basic HTTP authentication. Allowed headers-- Authorization: Basic bearerAuth: bearerFormat: auth-scheme description: >- Bearer HTTP authentication. Allowed headers-- Authorization: Bearer scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.