Update a check
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body
-
provider string
The name of the provider that ran the check.
-
type string
The type of check, possible values are aml, smartdoc and fraud
-
provider_reference string
The provider's unique identifier for the check.
-
status string
The check's status at the current time, possible values are abandoned, active, archive, complete, expired, failed, lock, pending and processing
-
outcome string
The check's outcome at the current time, possible values are pass, refer, fail, high_risk, medium_risk and low_risk
-
via_integration boolean
Did this check originate via an integration or was it manually added.
-
originally_ran_at string
The date that the check was originally ran
PUT /api/v1/account/{account_uuid}/check/{uuid}
curl \
-X PUT https://api.plannrcrm.com/api/v1/account/account_uuid/check/uuid \
-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 '{"provider":"SmartSearch","type":"fraud","provider_reference":"10009815","status":"completed","outcome":"refer","via_integration":false,"originally_ran_at":"2024-10-09T11:10:13+01:00"}'
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
{
"provider": "SmartSearch",
"type": "fraud",
"provider_reference": "10009815",
"status": "completed",
"outcome": "refer",
"via_integration": false,
"originally_ran_at": "2024-10-09T11:10:13+01:00"
}
Response examples (200)
{
"firm": {
"tax": 17.5,
"logo": "https://api.plannrcrm.com/images/plannr.jpg",
"name": "Codepotato",
"slug": "codepotato",
"uuid": "695df301-d600-43fd-85b8-28e12066bae3",
"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": "2024-10-16T11:10:13+01:00",
"updated_at": "2024-10-16T11:10:13+01: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",
"sidebar_background": "#0E0E56",
"sidebar_title_primary": "#FFC634",
"email_button_background": "#36367E",
"sidebar_title_secondary": "#ffffff",
"sidebar_title_background": "#36367E",
"email_logo_background_panel": "#36367E",
"sidebar_title_secondary_hover": "#ffffff"
},
"is_subscribed": true,
"regulatory_text": "Regulatory text",
"addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
"statement_frequency": "monthly",
"task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
"keep_deleted_files_for": 30,
"welcome_paragraph_html": "<h1>Welcome.</h1>",
"email_welcome_paragraph_html": "Welcome to Plannr!"
},
"type": "fraud",
"uuid": "22682bd4-b6d3-4f34-b724-0532fc7e8e48",
"client": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "088c969e-056e-43a1-ba0f-71700264ecb2",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-10-16T11:10:13+01:00",
"first_name": "Gareth",
"updated_at": "2024-10-16T11:10:13+01:00",
"with_login": true,
"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": "2024-10-16T11:10:13+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-10-16T11:10:13+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-10-16T11:10:13+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-10-16T11:10:13+01:00"
},
"folder": {
"name": "Important Documents",
"path": "Codepotato/Important Documents",
"slug": "important-documents",
"uuid": "fed9970f-8bec-47e6-a916-ba4ea601eab6",
"depth": 5,
"files": "App\\Http\\Resources\\FileResource",
"owned": false,
"parent": "App\\Http\\Resources\\FolderResource",
"folders": "App\\Http\\Resources\\FolderResource",
"parents": "App\\Http\\Resources\\FolderResource",
"children": "App\\Http\\Resources\\FolderResource",
"created_at": "2024-10-16T11:10:13+01:00",
"updated_at": "2024-10-16T11:10:13+01:00",
"files_count": 8,
"clients_read": true,
"participants": "App\\Http\\Resources\\FolderParticipantResource",
"clients_write": true,
"folders_count": 5,
"is_root_folder": true,
"is_pseudo_folder": true,
"is_system_folder": true,
"participants_count": 3,
"show_client_permissions": true
},
"status": "completed",
"outcome": "refer",
"provider": "SmartSearch",
"created_at": "2024-10-16T11:10:13+01:00",
"updated_at": "2024-10-16T11:10:13+01:00",
"last_webhook_at": "2024-10-09T11:10:13+01:00",
"via_integration": false,
"originally_ran_at": "2024-10-09T11:10:13+01:00",
"provider_reference": "10009815"
}