---
title: "Authenticate Using External Id"
method: POST
path: "/auth/external-id"
tags: ["Authentication"]
---

# Authenticate Using External Id

`POST /auth/external-id`

## Request

- Base URL: `https://ws.zipformplus.com/api`
- URL: `https://ws.zipformplus.com/api/auth/external-id`
- Auth: none required

Authenticates using the partner's External Id and Shared Key, and returns a Context Id.

## Request body

- object
  - `SharedKey` string, required
  - `ExternalId` string, required

## Response `200`

Authentication successful

- ContextIdResponse
  - `contextId` string: Session identifier to be used in subsequent requests

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/lwolf/apis/zipform-partner-api.md) · [All operations](https://skmtc.dev/lwolf/apis/zipform-partner-api/llms.txt) · [OpenAPI document](https://skmtc.dev/lwolf/apis/zipform-partner-api/revisions/89796ac90fc6?raw)