---
title: "POST /agent_sso"
method: POST
path: "/agent_sso"
tags: ["Agent SSO Token Authentication"]
---

# POST /agent_sso

`POST /agent_sso`

After your PayNearMe Technical Account Manager has configured your site to allow for Agent SSO Token Authentication, you can begin submitting calls  to the `/agent_sso` endpoint. The call returns an authenticating token and the SSO URL where the agent can access the Business Portal and/or the specific order.

## Request body

- AgentSso — Returns an authenticating token and SSO URL where an agent can access the Business Portal and/or a specific order.
  - `site_identifier` string, required — Identifies your client site.
  - `timestamp` string, required — The Unix Epoch time of the call
  - `version` string, required — The version of the API. This version must match the version associated with your API key pair.
  - `signature` string, required — The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.
  - `agent_email` string, required — The email address of the agent.
  - `agent_name` string, required — The name of the agent.
  - `agent_role` string, required — The name of the role set for this agent.
  - `order_identifier` string — One of the following order identifiers, which can be used to locate the order after the agent authenticates into the Business Portal<ul><li>`pnm_order_identifier`</li><li>`site_order_identifier`</li><li>`site_customer_identifier`</li></ul>

## Response `201`

API Keys Revoked

- AgentSsoResponse
  - `status` string — Indicates whether or not the SSO authenticating token was successfully created.
  - `token` string — The authenticating SSO token.
  - `token_expires` string — The date and timestamp when this token expires.
  - `sso_url` string — The SSO URL where the agent can access the Business Portal.

---

[API](https://skmtc.net/paynearme/apis/paynearme-api-v3-0.md) · [All operations](https://skmtc.net/paynearme/apis/paynearme-api-v3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paynearme/paynearme-api-v3-0/revisions/44cba4f8b80f/schema)