Create a check Run in API Explorer
Ask AI
Body
-
The name of the provider that ran the check.
-
The type of check, possible values are aml, smartdoc and fraud
Value Description aml Aml smartdoc Smartdoc fraud Fraud Values are
aml,smartdoc, orfraud. -
The provider's unique identifier for the check.
-
The check's status at the current time, possible values are abandoned, active, archive, complete, expired, failed, lock, pending and processing
Value Description abandoned Abandoned active Active archive Archive complete Complete expired Expired failed Failed lock Lock pending Pending processing Processing Values are
abandoned,active,archive,complete,expired,failed,lock,pending, orprocessing. -
The check's outcome at the current time, possible values are pass, refer, fail, high_risk, medium_risk and low_risk
Value Description pass Pass refer Refer fail Fail high_risk High Risk medium_risk Medium Risk low_risk Low Risk Values are
pass,refer,fail,high_risk,medium_risk, orlow_risk. -
Did this check originate via an integration or was it manually added.
-
The date that the check was originally ran
POST
/api/v1/account/{account_uuid}/check
curl \
--request POST 'https://api.plannrcrm.com/api/v1/account/6ff8f7f6-1eb3-3525-be4a-3932c805afed/check' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"provider":"SmartSearch","type":"aml","provider_reference":"10009815","status":"abandoned","outcome":"pass","via_integration":false,"originally_ran_at":"2025-12-09"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"provider": "SmartSearch",
"type": "aml",
"provider_reference": "10009815",
"status": "abandoned",
"outcome": "pass",
"via_integration": false,
"originally_ran_at": "2025-12-09"
}
Response examples (201)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "5782fa18-731c-4d4e-b348-727c4df46d84",
"county": "Hampshire",
"billing": {
"invoice_email": "gareth@codepotato.co.uk",
"invoice_county": "Hampshire",
"invoice_country": "United Kingdom",
"invoice_postcode": "PO7 7YH",
"invoice_address_1": "Suite E, 5 The Briars",
"invoice_address_2": "Waterberry Drive",
"invoice_town_city": "Waterlooville"
},
"country": "United Kingdom",
"postcode": "PO7 7YH",
"address_1": "Suite E, 5 The Briars",
"address_2": "Waterberry Drive",
"logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
"month_end": 25,
"town_city": "Waterlooville",
"created_at": "2025-12-16T17:00:06+00:00",
"updated_at": "2025-12-16T17:00:06+00:00",
"ip_whitelist": [
"192.168.0.1",
"127.0.0.1"
],
"brand_colours": {
"sidebar_text": "#FFFFFF",
"sidebar_hover": "#0A0A42",
"email_sub_text": "#FFFFFF",
"sidebar_accent": "#36367E",
"sidebar_active": "#53DBB8",
"email_background": "#0E0E56",
"email_button_text": "#FFFFFF",
"portal_background": "#F6F6F6",
"portal_brand_title": "#323B4B",
"sidebar_background": "#0E0E56",
"portal_sidebar_icon": "#828994",
"portal_sidebar_text": "#323B4B",
"portal_sidebar_title": "#11151D",
"sidebar_title_primary": "#FFC634",
"portal_brand_sub_title": "#828994",
"portal_sidebar_divider": "#E3E5E9",
"email_button_background": "#36367E",
"portal_dashboard_bg_one": "#EF4583",
"portal_dashboard_bg_two": "#FFC634",
"sidebar_title_secondary": "#FFFFFF",
"sidebar_title_background": "#36367E",
"portal_sidebar_icon_hover": "#828994",
"portal_sidebar_text_hover": "#323B4B",
"portal_sidebar_icon_active": "#828994",
"portal_sidebar_text_active": "#323B4B",
"email_logo_background_panel": "#36367E",
"portal_sidebar_button_hover": "#FFFFFF",
"portal_sidebar_account_email": "#828994",
"portal_sidebar_account_title": "#11151D",
"portal_sidebar_button_active": "#FFFFFF",
"sidebar_title_secondary_hover": "#FFFFFF",
"portal_sidebar_collapse_button": "#828994",
"portal_sidebar_user_select_text": "#323B4B",
"portal_sidebar_button_background": "#F6F6F6",
"portal_sidebar_user_select_hover": "#F6F6F6",
"portal_sidebar_user_select_border": "#EEEEEE",
"portal_sidebar_collapse_button_hover": "#B3B9C4",
"portal_sidebar_user_select_background": "#F6F6F6",
"portal_sidebar_user_select_text_hover": "#323B4B",
"portal_sidebar_user_select_border_hover": "#828994"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"cc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"bcc_email_addresses": [
"jack@example.com",
"jill@example.com"
],
"statement_frequency": "monthly",
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"keep_deleted_files_for": 30,
"reply_to_email_address": "jack@example.com",
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!",
"show_fact_find_illustrations": true
},
"type": "fraud",
"uuid": "bb157887-3bb8-4d0f-a25a-af56ef2769a6",
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "6d30d639-45ec-479f-a344-86ea07173117",
"depth": 5,
"files": "App\\Http\\Resources\\FileResource",
"owned": false,
"folders": "App\\Http\\Resources\\FolderResource",
"parents": "App\\Http\\Resources\\FolderResource",
"children": "App\\Http\\Resources\\FolderResource",
"ancestors": "App\\Http\\Resources\\FolderResource",
"created_at": "2025-12-16T17:00:06+00:00",
"updated_at": "2025-12-16T17:00:06+00:00",
"files_count": 8,
"clients_read": true,
"documentable": "Object",
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"documentable_type": "account",
"documentable_uuid": "account",
"participants_count": 3,
"show_client_permissions": true
},
"status": "completed",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "370c28e0-ef33-4fae-a971-5c608a84db38",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"circles": "App\\Http\\Resources\\CircleResource",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
"created_at": "2025-12-16T17:00:06+00:00",
"first_name": "Gareth",
"updated_at": "2025-12-16T17:00:06+00:00",
"with_login": true,
"inactive_at": "2025-12-16",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-12-16T17:00:06+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-12-16T17:00:06+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-12-16T17:00:06+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-12-16T17:00:06+00:00"
},
"outcome": "refer",
"provider": "SmartSearch",
"created_at": "2025-12-16T17:00:06+00:00",
"last_error": "SmartSearch could not process the request. Please contact support.",
"updated_at": "2025-12-16T17:00:06+00:00",
"last_webhook_at": "2025-12-09T17:00:06+00:00",
"via_integration": false,
"originally_ran_at": "2025-12-09T17:00:06+00:00",
"provider_reference": "10009815"
}