--- updatedAt: 2026-05-07T21:22:44.000Z agentTools: projectIndex: https://developer.firmcheck.com/llms.txt --- # Show a client Get a single client by their unique identifier. # OpenAPI definition ```json { "openapi": "3.0.2", "paths": { "/clients/{id}": { "get": { "description": "Get a single client by their unique identifier.", "summary": "Show a client", "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier for the client." }, { "name": "accept-version", "in": "header", "required": true, "schema": { "type": "string", "enum": [ "1.0.0" ] } } ], "operationId": "getClient", "responses": { "200": { "description": "200", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "format": "uri", "description": "The API url for this item" }, "web": { "type": "string", "format": "uri", "description": "The web url for this item" } }, "required": [ "self", "web" ] }, "id": { "type": "string", "description": "The unique identifier for the client." }, "object": { "type": "string", "enum": [ "client" ] }, "name": { "type": "string", "description": "The name of the client." }, "state": { "type": "string", "enum": [ "PROSPECT", "EXISTING", "ARCHIVED", "DISCARDED" ] }, "referenceNumber": { "type": "string", "description": "The reference number of the client." }, "category": { "type": "string", "enum": [ "INDIVIDUAL", "ORGANISATION", "SOLE_TRADER" ], "description": "The category of the client. Will determine the type of entity that is related to this client." }, "entity": { "oneOf": [ { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "format": "uri", "description": "The API url for this item" }, "web": { "type": "string", "format": "uri", "description": "The web url for this item" } }, "required": [ "self", "web" ] }, "id": { "type": "string", "description": "The unique identifier for the individual." }, "object": { "type": "string", "enum": [ "individual" ] }, "firstName": { "type": "string", "description": "The first name of the individual." }, "middleName": { "type": "string", "description": "The middle name of the individual." }, "lastName": { "type": "string", "description": "The last name of the individual." }, "email": { "type": "string", "description": "The email address of the individual." }, "residentialAddress": { "type": "object", "properties": { "line1": { "type": "string", "nullable": true }, "line2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "description": "The residential address of the individual." }, "birth": { "type": "object", "properties": { "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } }, "required": [ "year" ], "description": "The birth date of the individual. Split into parts as the full date is not always available." }, "client": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "format": "uri", "description": "The API url for this item" }, "web": { "type": "string", "format": "uri", "description": "The web url for this item" } }, "required": [ "self", "web" ] }, "id": { "type": "string", "description": "The unique identifier for the client." } }, "required": [ "links", "id" ], "description": "A reference to the client associated with this individual, if one exists." }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "links", "id", "object", "firstName", "lastName", "createdAt", "updatedAt" ], "description": "An individual person." }, { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "format": "uri", "description": "The API url for this organisation" }, "web": { "type": "string", "format": "uri", "description": "The web url for this organisation" }, "relatedParties": { "type": "string", "format": "uri", "description": "The API url for the related parties of this organisation" } }, "required": [ "self", "web", "relatedParties" ] }, "id": { "type": "string", "description": "The unique identifier for the organisation." }, "object": { "type": "string", "enum": [ "organisation" ] }, "name": { "type": "string", "description": "The name of the organisation." }, "companyNumber": { "type": "string", "description": "The company number of the organisation. Populated when the company was imported via Companies House UK" }, "identifyingNumber": { "type": "string", "description": "The identifying number of the organisation. Used when company has been created without Companies House UK" }, "organisationType": { "type": "string", "enum": [ "COMPANY", "NON_PROFIT", "TRUST", "OTHER" ], "description": "The type of the organisation." }, "organisationSubType": { "type": "string", "description": "The sub type of the organisation." }, "registeredAddress": { "type": "object", "properties": { "line1": { "type": "string", "nullable": true }, "line2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "description": "The registered address of the organisation." }, "tradingAddress": { "type": "object", "properties": { "line1": { "type": "string", "nullable": true }, "line2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "description": "The trading address of the organisation." }, "client": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "format": "uri", "description": "The API url for this item" }, "web": { "type": "string", "format": "uri", "description": "The web url for this item" } }, "required": [ "self", "web" ] }, "id": { "type": "string", "description": "The unique identifier for the client." } }, "required": [ "links", "id" ], "description": "A reference to the client associated with this organisation, if one exists." }, "relatedPartiesCount": { "type": "number", "description": "The count of related parties for this organisation. Only included on single organisation GET." }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "links", "id", "object", "name", "organisationType", "relatedPartiesCount", "createdAt", "updatedAt" ], "description": "An organisation." }, { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "format": "uri", "description": "The API url for this item" }, "web": { "type": "string", "format": "uri", "description": "The web url for this item" } }, "required": [ "self", "web" ] }, "id": { "type": "string", "description": "The unique identifier for the sole trader." }, "object": { "type": "string", "enum": [ "sole_trader" ] }, "tradingName": { "type": "string", "description": "The trading name of the sole trader." }, "individual": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "format": "uri", "description": "The API url for this item" }, "web": { "type": "string", "format": "uri", "description": "The web url for this item" } }, "required": [ "self", "web" ] }, "id": { "type": "string", "description": "The unique identifier for the individual." }, "object": { "type": "string", "enum": [ "individual" ] }, "firstName": { "type": "string", "description": "The first name of the individual." }, "middleName": { "type": "string", "description": "The middle name of the individual." }, "lastName": { "type": "string", "description": "The last name of the individual." }, "email": { "type": "string", "description": "The email address of the individual." }, "residentialAddress": { "type": "object", "properties": { "line1": { "type": "string", "nullable": true }, "line2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postcode": { "type": "string", "nullable": true }, "county": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "description": "The residential address of the individual." }, "birth": { "type": "object", "properties": { "day": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } }, "required": [ "year" ], "description": "The birth date of the individual. Split into parts as the full date is not always available." }, "client": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "format": "uri", "description": "The API url for this item" }, "web": { "type": "string", "format": "uri", "description": "The web url for this item" } }, "required": [ "self", "web" ] }, "id": { "type": "string", "description": "The unique identifier for the client." } }, "required": [ "links", "id" ], "description": "A reference to the client associated with this individual, if one exists." }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "links", "id", "object", "firstName", "lastName", "createdAt", "updatedAt" ], "description": "The individual related to this sole trader." }, "client": { "type": "object", "properties": { "links": { "type": "object", "properties": { "self": { "type": "string", "format": "uri", "description": "The API url for this item" }, "web": { "type": "string", "format": "uri", "description": "The web url for this item" } }, "required": [ "self", "web" ] }, "id": { "type": "string", "description": "The unique identifier for the client." } }, "required": [ "links", "id" ], "description": "A reference to the client associated with this sole trader, if one exists." }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "links", "id", "object", "individual", "createdAt", "updatedAt" ], "description": "A sole trader, which is an individual with an associated trading name." } ], "description": "The entity this client represents. Will be determined by the category of the client." }, "amlDeterminationStatus": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE" ], "description": "The status of the clients AML determination. Will be NOT_STARTED if no determination has ever been made for the client." }, "lastAmlDetermination": { "type": "object", "properties": { "riskLevel": { "type": "string", "enum": [ "PENDING", "LOW", "NORMAL", "MEDIUM", "HIGH" ], "description": "The risk level of the client based on the last AML determination." }, "completedAt": { "type": "string", "format": "date-time" } }, "required": [ "riskLevel", "completedAt" ], "description": "The result of the last AML determination for this client. Will be unset if no determination has been made yet." }, "lastModifiedAt": { "type": "string", "format": "date-time", "description": "When the client or its related entity or aml determination was last modified." }, "nextReviewDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "The date of the next review for this client in ISO-8601 format (YYYY-MM-DD). This is optional, as it will be set when an AML determination has been completed for the client." }, "partner": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the staff member." }, "name": { "type": "string", "description": "The name of the staff member." } }, "required": [ "id", "name" ], "description": "A reference to a staff member." }, "manager": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the staff member." }, "name": { "type": "string", "description": "The name of the staff member." } }, "required": [ "id", "name" ], "description": "A reference to a staff member." }, "businessUnit": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the business unit." }, "name": { "type": "string", "description": "The name of the business unit." }, "type": { "type": "string", "description": "The type of the business unit." } }, "required": [ "id", "name", "type" ], "description": "A reference to a business unit." }, "services": { "type": "array", "items": { "type": "string" }, "description": "The services that this client is receiving." }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "links", "id", "object", "name", "state", "category", "entity", "amlDeterminationStatus", "lastModifiedAt", "services", "createdAt", "updatedAt" ], "description": "The main response data" } }, "required": [ "data" ] } } } }, "404": { "description": "404" } } } } }, "info": { "title": "Firmcheck API", "version": "1.0.0" }, "servers": [ { "description": "Production", "url": "https://api.firmcheck.com" }, { "description": "Development", "url": "https://api.dev.beta-firmcheck.com" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "security": [ { "bearerAuth": [] } ], "x-readme": { "proxy-enabled": false } } ```