Authentication

Authenticate Using User Credentials

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.

post/auth/user

Request

  • Base URL: https://ws.zipformplus.com/api
  • URL: https://ws.zipformplus.com/api/auth/user
  • Auth: none required

Request body

SharedKeystring required

Partner shared key

UserNamestring

zipForm® username (use with Password)

Passwordstring

zipForm® password

UserIdstring

zipForm® user GUID (alternative to UserName/Password)

LinkExternalIdstring

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

Response

Authentication successful

contextIdstring

Session identifier to be used in subsequent requests

Changes

No recorded changes to this operation across all 1 revision of this API.