Create an FCA Number for a Firm

POST /api/v1/firm/{firm}/fca

Headers

Path parameters

firm integer Required

application/json

Body Required

fca_number integer Required

An FCA Number in a 6 or 7-digit format

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- fca_number integer
  
  FCA Number
- status string
  
  FCA Number Status, possible values are pending, verified and rejected
- rejected_reason string
  
  Reason for rejection
- actioned_at string
  
  DateTime FCA Number was verified or rejected

POST /api/v1/firm/{firm}/fca

curl \
 -X POST https://api.plannrcrm.com/api/v1/firm/firm/fca \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"fca_number":123456}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "fca_number": 123456
}

Response examples (201)

{
  "uuid": "59e76f94-d7b2-4777-9087-6a9bb3a33ee9",
  "status": "verified",
  "fca_number": 123456,
  "actioned_at": "2024-11-20T13:23:59+00:00",
  "rejected_reason": "Reason for rejection"
}