Authenticate Using User Credentials

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.lwolf.com/doc/zipform-api/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "ZipForm API MCP server": {
    "url": "https://apidocs.lwolf.com/doc/zipform-api/mcp"
  }
}
Close
POST /auth/user

Authenticates the partner application and a zipForm® user using username/password or user GUID, and returns a Context Id for use in subsequent requests.

Optionally supply LinkExternalId to link the user's account to a partner external ID.

Returns 409 if account linking fails.

application/json

Body Required

  • SharedKey string Required

    Partner shared key

  • UserName string

    zipForm® username (use with Password)

  • Password string

    zipForm® password

  • UserId string

    zipForm® user GUID (alternative to UserName/Password)

  • LinkExternalId string

    Optional. Partner external ID to link to this zipForm® account.

Responses

  • 200 application/json

    Authentication successful

    Hide response attribute Show response attribute object
    • contextId string

      Session identifier to be used in subsequent requests
  • 401

    Unauthorized — invalid credentials

  • 409

    Account linking failed

POST /auth/user 
curl \
 --request POST 'https://ws.zipformplus.com/api/auth/user' \
 --header "Content-Type: application/json" \
 --data '{"SharedKey":"string","UserName":"string","Password":"string","UserId":"string","LinkExternalId":"string"}'
Request examples 
{
  "SharedKey": "string",
  "UserName": "string",
  "Password": "string",
  "UserId": "string",
  "LinkExternalId": "string"
}
Response examples (200) 
{
  "contextId": "string"
}