Dealer Contact

The Dealer FCA API allows you to request and update specific FCA regulator information for a given dealer

The Dealer FCA Resource

Properties

Name
id
Required
Type
integer
Description
Unique identifier for the dealer FCA record. This is not the dealer ID.
Name
dealer_id
Required
Type
integer
Description
The unique ID for the dealer.
Name
application_status
Required
Type
FcaApplicationStatusEnum
Description
The FCA application status for the dealer
Name
fca_number
Required
Type
string | null
Description
The unique FCA number for the dealer, or null if the dealer does not have a valid application yet.
Name
fca_start_date
Required
Type
datetime | null
Description
The date the dealers FCA application was successful, represented in YYYY-MM-DD HH:MM:SS format. The time portion of the value will always be set to 00:00:00.
Name
dates.created_at
Required
Type
datetime
Description
The date the dealer fca record was created, represented in YYYY-MM-DD HH:MM:SS format
Name
dates.updated_at
Required
Type
datetime
Description
The date the dealer's fca record was last updated, represented in YYYY-MM-DD HH:MM:SS format
Name
dates.deleted_at
Required
Type
null | datetime
Description
The date the dealer's fca record was deleted, represented in YYYY-MM-DD HH:MM:SS format. If the dealer fca record is not deleted, this will be null

Dealer FCA Resource

{
  "id": 1,
  "dealer_id": 12345,
  "application_status": "on-register-able-to-sell",
  "fca_number": "123456ABC",
  "fca_start_date": "2024-01-01 00:00:00",
  "dates": {
    "created_at": "2024-01-01 00:00:00",
    "updated_at": "2024-01-02 12:00:00",
    "deleted_at": null,
  }
}

GET/v2/dealers/:dealer_id/fca

Retrieve FCA Record

Will retrieve a specific dealers fca record.

URL Parameters

Name
dealer_id
Required
required
Type
integer
Description
ID of the dealer to retrieve

Error Codes

Status	Description
404	The requested dealer could not be found

Request

GET

/v2/dealers/:dealer_id/fca

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

private ApexV3SdkInterface $sdk;

$response = $this->sdk
  ->v2(new Machine())
  ->dealer(1)
  ->fca()
  ->get();

Response

{
  "data": {
    "id": 1,
    "dealer_id": 12345,
    "application_status": "on-roll-able-to-sell",
    "fca_number": "1123456ABC",
    "fca_start_date": "2024-01-01 00:00:00",
    "dates": {
      "created_at": "2024-01-01 00:00:00",
      "updated_at": "2024-01-02 00:00:00",
      "deleted_at": null,
    }
  }
}

PUT/v2/dealers/:dealer_id/fca

Update FCA Data

Will attempt to update the the FCA details for the dealer. Only values provided in the request payload will be updated. Any values not specified will remain as their existing values, or set to null.

URL Parameters

Name
dealer_id
Required
required
Type
integer
Description
ID of the dealer to update

Payload

Name
application_status
Required
Type
string<FcaApplicationStatusEnum>
Description
The FCA Application status value to set the dealer to
Name
fca_number
Required
Type
string | null
Description
The FCA registration number for the dealer.
Name
fca_start_date
Required
Type
date | null
Description
The date the FCA application was successful, or null to void. The time value can be provided, but will be ignored.

Error Codes

Status	Description
404	The requested dealer could not be found.
422	The data provided in the payload was invalid. See errors for more details.

Request

PUT

/v2/dealers/:dealer_id/fca

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

private ApexV3SdkInterface $sdk;

// To update a single contact method
$response = $this->sdk
  ->v2(new Machine())
  ->dealer(1)
  ->update([
    'application_status' => 'on-register-able-to-sell',
    'fca_number' => '1123456ABC',
    'fca_start_date' => '2024-01-01',
  ]);

Response

{
  "data": {
    "id": 1,
    "dealer_id": 12345,
    "application_status": "on-roll-able-to-sell",
    "fca_number": "1123456ABC",
    "fca_start_date": "2024-01-01 00:00:00",
    "dates": {
      "created_at": "2024-01-01 00:00:00",
      "updated_at": "2024-01-02 00:00:00",
      "deleted_at": null,
    }
  }
}