Workflow

Portal login, registration and password reset

Use code-backed email/password login, client registration and forgotten-password endpoints.

15 connected guidesLive filterPermission-aware instructions
15 guides
Category

Proplix Secure API Gateway

Open guide →
Guide

Log in a client through the API

POST the master token plus valid email/password to /portal_api/login; successful authentication returns a short-lived client session.

Open guide →
Guide

Use POST for portal login

Other methods are rejected.

Open guide →
Guide

Complete login email

Use the client contact email.

Open guide →
Guide

Complete login password

Use the client portal password; do not log it.

Open guide →
Guide

Set login session expires_in

Optional 60–900 seconds, default 600.

Open guide →
Guide

Resolve failed portal login

Check active contact, password, client account and master profile controls.

Open guide →
Guide

Register a client account through the API

POST supported identity/company/contact/password fields to /portal_api/register.

Open guide →
Guide

Understand registration validation

The production model validates required data, email/account conflicts and password/consent conditions exposed by its input flow.

Open guide →
Guide

Understand registration result

Successful registration can create/authenticate the client identity and return session context.

Open guide →
Guide

Request a client password reset

POST the client email to /portal_api/forgot_password.

Open guide →
Guide

Understand privacy-safe reset behaviour

Use the returned success/message without exposing whether an unrelated account exists.

Open guide →
Guide

Understand CSRF exclusions

Only server-to-server session, login, registration, forgot-password and Scroll document-upload endpoints are excluded.

Open guide →
Guide

Understand retired client endpoint

The legacy arbitrary client-ID endpoint is retired and instructs integrations to use session/me.

Open guide →
Guide

Understand retired contact endpoint

The legacy arbitrary contact-ID endpoint is retired and instructs integrations to use session/me.

Open guide →