> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check Temporary Key

> Check a temporary key for validity, and in case it is valid, return its domain, targetId and personId

NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-PersonAgent.json post /api/v1/Agents/Person/CheckTemporaryKey
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - PersonAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Person/CheckTemporaryKey:
    post:
      tags:
        - Person_Agent
      summary: Check Temporary Key
      description: >-
        Check a temporary key for validity, and in case it is valid, return its
        domain, targetId and personId


        NsApiSlow threshold: 2000 ms.
      operationId: v1PersonAgent_CheckTemporaryKey
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.CheckTemporaryKeyRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.CheckTemporaryKeyRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.CheckTemporaryKeyRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.CheckTemporaryKeyRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.CheckTemporaryKeyRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.CheckTemporaryKeyRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PersonCarriers.CheckTemporaryKeyRequest
        description: TemporaryKey
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TemporaryKeyInfo'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TemporaryKeyInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TemporaryKeyInfo'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TemporaryKeyInfo'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TemporaryKeyInfo'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TemporaryKeyInfo'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.PersonCarriers.CheckTemporaryKeyRequest:
      description: >-
        CheckTemporaryKey: Check a temporary key for validity, and in case it is
        valid, return its domain, targetId and personId
      type: object
      properties:
        TemporaryKey:
          type: string
    SuperOffice.CRM.Services.TemporaryKeyInfo:
      description: "The fields returned when checking a temporary key\r\n<para />\r\nCarrier object for TemporaryKeyInfo.\r\nServices for the TemporaryKeyInfo Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPersonAgent\">Person Agent</see>."
      type: object
      properties:
        Domain:
          description: The domain for this key. Unknown if key is not valid.
          enum:
            - Unknown
            - MailingRecipient
            - FormSubmitterRecipient
            - ViewTicketInCustomerCenter
            - LoginCustomerCenter
            - PublicFaq
            - ChangePasswordCustomerCenter
            - RegisterCustomerCenterEmailVerification
          type: string
        TargetId:
          format: int32
          description: >-
            The primary key of the entity this temporary key is for, dependent
            of dmain
          type: integer
        PersonId:
          format: int32
          description: The person id this key is related to. May be null.
          type: integer
        IsExpired:
          description: Whether the key is expired or not.
          type: boolean
        Payload:
          description: The payload for this key. May be null or empty.
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.Person CheckTemporaryKeyRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Person_CheckTemporaryKeyRequest.md)
- [NSPersonAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSPersonAgent.md)
- [SuperOffice.WebApi.Agents.PersonAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.PersonAgent.md)
- [SuperOffice.WebApi.Agents.IPersonAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IPersonAgent.md)
- [Create Temporary Key](/en/api/reference/restful/agent/person_agent/create-temporary-key.md)
- [TemporaryKey table](/en/database/tables/temporarykey.md)