Portal Registration

The Customer Portal Registration API allows you to manage manage the customers portal access.

The Portal Registration Resource

Properties

Name
customer_id
Required
Type
integer
Description
The ID if the customer
Name
is_registered
Required
Type
boolean
Description
Will be set to true if the customer has registered for portal access. If the customer hasn't registered, or not yet been sent registration details, this will be set to false.
Name
registered_at
Required
Type
datetime | null
Description
If the customer has registered for the portal, this will be set to their registration date, provided in YYYY-MM-DD HH:MM:SS format. If they haven't registered, this will be set to null.

Portal Registration Resource

{
  "customer_id": 1,
  "is_registered": true,
  "registered_at": "2025-01-01 00:00:00"
}

GET/v2/customers/:customer_id/portal

Retrieve Portal Registration Details

Will retrieve the portal registration details for the given customer.

URL Parameters

Name
customer_id
Required
required
Type
integer
Description
ID of the customer to retrieve the portal details of

Error Codes

Status	Description
404	The requested customer could not be found.

Request

GET

/v2/customers/:customer_id/portal

use Compliance\Sdk\ApexV3\Contracts\ApexV3SdkInterface;
use Compliance\Sdk\Authentication\Types\Machine;

private ApexV3SdkInterface $sdk;

$response = $this->sdk
  ->v2(new Machine())
  ->customer(1)
  ->portal()
  ->get();

Response

{
  "data": {
    "customer_id": 1,
    "is_registered": true,
    "registered_at": "2025-01-01 00:00:00"
  }
}