This is a important
This is a link
"}},"note_html_with_mention":{"summary":"Create a HTML note with mention","value":{"case_id":"ba883bef-60fd-42d0-a447-7b7c987c3155","content":"This will mention and sent him a notification
"}}}}}},"responses":{"201":{"description":"Note has been created in the case\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n - Make sure the body payload matches the expected schema\n - Maximum items reached (default: 25). Contact us at support@dotfile.com if you need more items.\n "},"404":{"description":"No case can be found."}},"tags":["Notes"]}},"/v1/notes/{id}/comments":{"post":{"operationId":"note-create-one-note-comment","summary":"Create a note comment","description":"Create a comment on a note.\n\n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the note comment","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteCommentCreate"},"examples":{"comment_plain_text":{"summary":"Create a plain text comment","value":{"content":"This is a comment!"}},"comment_html":{"summary":"Create a HTML comment","value":{"content":"This is a important
This is a link
"}},"comment_html_with_mention":{"summary":"Create a HTML comment with mention","value":{"content":"This will mention and sent him a notification
"}}}}}},"responses":{"201":{"description":"Comment has been created on the note\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteComment"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n - Make sure the body payload matches the expected schema\n - Maximum items reached (default: 50). Contact us at support@dotfile.com if you need more items.\n "},"404":{"description":"No note can be found."}},"tags":["Notes"]}},"/v1/activities":{"get":{"operationId":"activity-get-many","summary":"List all activities","description":"Return a list of all activities in your Dotfile workspace\n\n---\n\n#### See also \nLearn more about [Filtering, Sorting and Pagination](./filtering-sorting-and-pagination) \n","parameters":[{"name":"case_id","required":false,"in":"query","description":"Filter items by the `case_id.{operator}` field. \nYou can use the `eq` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"individual_id","required":false,"in":"query","description":"Filter items by the `individual_id.{operator}` field. \nYou can use the `eq` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"company_id","required":false,"in":"query","description":"Filter items by the `company_id.{operator}` field. \nYou can use the `eq` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"type","required":false,"in":"query","description":"Filter items by the `type.{operator}` field. \nYou can use the `eq`, `not_eq`, `in` and `not_in` operators, the `eq` operator being the default. \nComma separated for multiple values (`in` and `not_in`).","schema":{"type":"string","enum":["api__created__case","contact__created__case","user__created__case","api__updated_info__case","contact__updated_info__case","user__updated_info__case","api__updated_status__case","user__updated_status__case","system__updated_status__case","api__updated_template__case","user__updated_template__case","system__updated_template__case","workflow__updated_template__case","api__updated_assignee__case","user__updated_assignee__case","system__updated_assignee__case","user__transferred_from_workspace__case","api__updated_metadata__case","contact__updated_metadata__case","user__updated_metadata__case","api__updated_risk__case","user__updated_risk__case","workflow__updated_risk__case","system__updated_risk__case","system__updated_review__case","user__updated_review__case","api__confirmed_review__case","system__confirmed_review__case","user__confirmed_review__case","api__deleted__case","user__deleted__case","api__added_tags__case","user__added_tags__case","system__added_tags__case","workflow__added_tags__case","api__removed_tags__case","user__removed_tags__case","system__added__case_control","system__removed__case_control","template__added__case_control","template__removed__case_control","api__updated__case_relation","contact__updated__case_relation","user__updated__case_relation","user__sent__communication","system__sent__communication","system__received__communication","api__created__individual","contact__created__individual","user__created__individual","api__updated__individual","contact__updated__individual","user__updated__individual","api__marked_as_relevant__individual","user__marked_as_relevant__individual","api__marked_as_not_relevant__individual","contact__marked_as_not_relevant__individual","user__marked_as_not_relevant__individual","contact__sent_collaboration_email__individual","api__deleted__individual","user__deleted__individual","api__created__company","contact__created__company","user__created__company","api__updated__company","contact__updated__company","user__updated__company","api__marked_as_relevant__company","user__marked_as_relevant__company","api__marked_as_not_relevant__company","contact__marked_as_not_relevant__company","user__marked_as_not_relevant__company","api__deleted__company","user__deleted__company","user__purchased__company_data","api__started__check","contact__started__check","user__started__check","system__started__check","system__rolled_back__check","template__started__check","workflow__started__check","api__set_review_needed__check","contact__set_review_needed__check","system__set_review_needed__check","api__approved__check","user__approved__check","system__approved__check","api__rejected__check","user__rejected__check","system__rejected__check","api__enabled_monitoring__check","user__enabled_monitoring__check","api__disabled_monitoring__check","user__disabled_monitoring__check","system__disabled_monitoring__check","system__expired__check","end_user__started_flow__check","end_user__finished_flow__check","user__deleted__check","api__deleted__check","api__ignored__aml_hit","user__ignored__aml_hit","api__confirmed__aml_hit","user__confirmed__aml_hit","user__acknowledged__company_monitoring_alert","user__run__template","api__run__template","system__run__template","contact__completed_forms__client_portal","contact__completed_checks__client_portal","user__mark_as_completed__case_control","system__mark_as_completed__case_control","user__mark_as_uncompleted__case_control","system__mark_as_uncompleted__case_control"]}},{"name":"author_id","required":false,"in":"query","description":"Filter items by the `author_id.{operator}` field. \nYou can use the `eq` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"created_at","required":false,"in":"query","description":"Filter items by the `created_at.{operator}` field. \nYou can use the `eq`, `gte`, `lte`, `gt` and `lt` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"sort","required":false,"in":"query","description":"Use this parameter to sort query results. \nIf not specified, sorted in _ascending_ order with values of field `created_at`. \nAvailable fields are `created_at`.","schema":{"default":"created_at","type":"string"},"examples":{"created_at":{"summary":"Sort by values of the \"created_at\" field in ascending order","value":"created_at"},"created_at_descending":{"summary":"Sort by values of the \"created_at\" field in descending order","value":"created_at.desc"}}},{"name":"page","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose which page you want to display. \nPage index starts at 1 (the default).","schema":{"default":1,"type":"number","minimum":1}},{"name":"limit","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose the number of items per page. \nLimit defaults to 20, maximum value is 100.","schema":{"type":"number","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"List of activities in the workspace\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityList"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter.\n - If specified, make sure the value of the `page` or `limit` query parameter are valid.\n - Value of the `sort` parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.\n "}},"tags":["Activities"]}},"/v1/cases/{id}/tags":{"post":{"operationId":"case-tag-create-case-tags","summary":"Add tags to case","description":"Add tags to your case.\n\n---\n\n#### See also \nLearn more about [Cases](./cases-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the case","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseTagsCreate"}}}},"responses":{"201":{"description":"Tags attached to your case\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagList"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the body payload matches the expected schema\n "},"404":{"description":"Case not found or tags not found on case"}},"tags":["Tags"]},"get":{"operationId":"case-tag-get-case-tags","summary":"Get case's tags","description":"Get tags attached to your case.\n\n---\n\n#### See also \nLearn more about [Cases](./cases-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the case","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"Tags attached to your case\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagList"}}}},"404":{"description":"Case not found"}},"tags":["Tags"]},"delete":{"operationId":"case-tag-delete-case-tags","summary":"Delete case's tags","description":"Delete tags attached to your case.\n\n---\n\n#### See also \nLearn more about [Cases](./cases-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the case","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseTagsCreate"}}}},"responses":{"200":{"description":"Tags attached to your case\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagList"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the body payload matches the expected schema\n "},"404":{"description":"Case not found or tags not found on case"}},"tags":["Tags"]}},"/v1/tags":{"get":{"operationId":"tag-get-many","summary":"List all tags","description":"Returns a list of all tags in your Dotfile workspace.\n\n---\n\n#### See also \nLearn more about [Filtering, Sorting and Pagination](./filtering-sorting-and-pagination) \n","parameters":[{"name":"label","required":false,"in":"query","description":"Filter items by the `label.{operator}` field. \nYou can use the `eq`, `not_eq`, `like` and `ilike` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"created_at","required":false,"in":"query","description":"Filter items by the `created_at.{operator}` field. \nYou can use the `eq`, `not_eq`, `gt`, `gte`, `lt` and `lte` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"sort","required":false,"in":"query","description":"Use this parameter to sort query results. \nIf not specified, sorted in _ascending_ order with values of field `created_at`. \nAvailable fields are `created_at` and `label`.","schema":{"default":"created_at","type":"string"},"examples":{"created_at":{"summary":"Sort by values of the \"created_at\" field in ascending order","value":"created_at"},"label":{"summary":"Sort by values of the \"label\" field in descending order","value":"label.desc"},"multiple":{"summary":"Sort by values of multiple fields","value":"created_at,label.desc"}}},{"name":"page","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose which page you want to display. \nPage index starts at 1 (the default).","schema":{"default":1,"type":"number","minimum":1}},{"name":"limit","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose the number of items per page. \nLimit defaults to 20, maximum value is 100.","schema":{"type":"number","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"List of tags in the workspace\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagPaginatedList"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter.\n - If specified, make sure the value of the `page` or `limit` query parameter are valid.\n - Value of the `sort` parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.\n "}},"tags":["Tags"]},"post":{"operationId":"tag-create-one","summary":"Create a tag","description":"Create a tag in your workspace.\n\n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagCreate"}}}},"responses":{"201":{"description":"Tag has been created in the workspace\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the body payload matches the expected schema\n - Maximum items reached (default: 200). Contact us at support@dotfile.com if you need more items.\n "}},"tags":["Tags"]}},"/v1/tags/{id}":{"get":{"operationId":"tag-get-one","summary":"Retrieve a tag","description":"Get the specified tag.\n\n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the tag","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"404":{"description":"No tag can be found."}},"tags":["Tags"]},"patch":{"operationId":"tag-update-one","summary":"Update a tag","description":"Update the specified tag.\n\n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the tag","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagUpdate"}}}},"responses":{"200":{"description":"Returns the updated tag\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n - Make sure the body payload matches the expected schema\n "},"404":{"description":"No tag can be found."}},"tags":["Tags"]},"delete":{"operationId":"tag-delete-one","summary":"Delete a tag","description":"Delete the specified tag.\n\n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the tag","schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n "},"404":{"description":"No tag can be found."}},"tags":["Tags"]}},"/v1/files/upload":{"post":{"operationId":"file-upload-file","summary":"Upload a file","description":"Upload a file and get an `upload_ref` to be used for Identity Document Check or Documents checks.\n\n---\n\nMaximum file size is at most **20MB** but may vary depending on the usage afterward.\n\nThe `upload_ref` is valid for about **1 day**.\n\nThe accepted file formats are:\n- Image files: \n - `.avif`: AVIF image (`image/avif`) \n - `.bmp`: Windows OS/2 Bitmap Graphics (`image/bmp`) \n - `.gif`: Graphics Interchange Format (GIF, `image/gif`) \n - `.ico`: Icon format (`image/vnd.microsoft.icon`) \n - `.ico`: Icon format (`image/x-icon`) \n - `.jpeg, .jpg`: JPEG images (`image/jpeg`) \n - `.png`: Portable Network Graphics (`image/png`) \n - `.svg`: Scalable Vector Graphics (SVG, `image/svg+xml`) \n - `.tif, .tiff`: Tagged Image File Format (TIFF, `image/tiff`) \n - `.webp`: WEBP image (`image/webp`) \n- Office files: \n - `.doc`: Microsoft Word (`application/msword`) \n - `.docx`: Microsoft Word (OpenXML, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`) \n - `.odp`: OpenDocument presentation document (`application/vnd.oasis.opendocument.presentation`) \n - `.ods`: OpenDocument spreadsheet document (`application/vnd.oasis.opendocument.spreadsheet`) \n - `.odt`: OpenDocument text document (`application/vnd.oasis.opendocument.text`) \n - `.pdf`: Adobe Portable Document Format (PDF, `application/pdf`) \n - `.ppt`: Microsoft PowerPoint (`application/vnd.ms-powerpoint`) \n - `.pptx`: Microsoft PowerPoint (OpenXML, `application/vnd.openxmlformats-officedocument.presentationml.presentation`) \n - `.vsd`: Microsoft Visio (`application/vnd.visio`) \n - `.xls`: Microsoft Excel (`application/vnd.ms-excel`) \n - `.xlsx`: Microsoft Excel (OpenXML, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`) \n- Text files: \n - `.csv`: Comma-separated values (CSV, `text/csv`) \n - `.json`: JSON format (`application/json`) \n - `.jsonld`: JSON-LD format (`application/ld+json`) \n - `.rtf`: Rich Text Format (RTF, `application/rtf`) \n - `.txt`: Text, (generally ASCII or ISO 8859-n, `text/plain`) \n- Archive files: \n - `.arc`: Archive document (multiple files embedded, `application/x-freearc`) \n - `.bz`: BZip archive (`application/x-bzip`) \n - `.bz2`: BZip2 archive (`application/x-bzip2`) \n - `.gz`: GZip Compressed Archive (`application/gzip`) \n - `.rar`: RAR archive (`application/vnd.rar`) \n - `.tar`: Tape Archive (TAR, `application/x-tar`) \n - `.zip`: ZIP archive (`application/zip`) \n - `.7z`: 7-zip archive (`application/x-7z-compressed`) \n - `.7z`: 7-zip archive on windows (`application/x-compressed`) \n - `.zip`: ZIP archive on windows (`application/x-zip-compressed`)\n\n---\n\n#### See also \nLearn more about [Files](./files-guide) \n","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"File uploaded and reference ready to be used.\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadedFile"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - When the file is missing\n - When the file is empty\n "},"413":{"description":"File too large, maximum file size is **20MB**."},"415":{"description":"File type not supported."}},"tags":["Files"]}},"/v1/files/{id}":{"get":{"operationId":"file-get-file","summary":"Download a file","description":"Download a file. Get file content as standard `binary/octet-stream` File.\n\n---\n\n#### See also \nLearn more about [Files](./files-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the file","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"Get File content\n\n**ℹ️ Click to see full payload**","content":{"*/*":{"schema":{"type":"string","format":"binary"},"example":"File"}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n "},"404":{"description":"No file can be found."}},"tags":["Files"]}},"/v1/templates":{"get":{"operationId":"template-get-many","summary":"List all templates","description":"Returns a list of all templates created in your Dotfile workspace.\n\n---\n\n#### See also \nLearn more about [Templates](./templates-guide) \nLearn more about [Filtering, Sorting and Pagination](./filtering-sorting-and-pagination) \n","parameters":[{"name":"name","required":false,"in":"query","description":"Filter items by the `name.{operator}` field. \nYou can use the `eq`, `not_eq`, `like` and `ilike` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"key","required":false,"in":"query","description":"Filter items by the `key.{operator}` field. \nYou can use the `eq`, `not_eq`, `like` and `ilike` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"case_auto_approval","required":false,"in":"query","description":"Filter items by the `case_auto_approval.{operator}` field. \nYou can use the `eq` and `not_eq` operators, the `eq` operator being the default.","schema":{"type":"boolean"}},{"name":"created_at","required":false,"in":"query","description":"Filter items by the `created_at.{operator}` field. \nYou can use the `eq`, `not_eq`, `gt`, `gte`, `lt` and `lte` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"updated_at","required":false,"in":"query","description":"Filter items by the `updated_at.{operator}` field. \nYou can use the `eq`, `not_eq`, `gt`, `gte`, `lt` and `lte` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"sort","required":false,"in":"query","description":"Use this parameter to sort query results. \nIf not specified, sorted in _ascending_ order with values of field `updated_at`. \nAvailable fields are `created_at`, `name` and `updated_at`.","schema":{"default":"updated_at","type":"string"},"examples":{"created_at":{"summary":"Sort by values of the \"created_at\" field in ascending order","value":"created_at"},"name":{"summary":"Sort by values of the \"name\" field in descending order","value":"name.desc"},"updated_at":{"summary":"Sort by values of the \"updated_at\" field in ascending order","value":"updated_at"},"multiple":{"summary":"Sort by values of multiple fields","value":"created_at,name.desc"}}},{"name":"page","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose which page you want to display. \nPage index starts at 1 (the default).","schema":{"default":1,"type":"number","minimum":1}},{"name":"limit","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose the number of items per page. \nLimit defaults to 20, maximum value is 100.","schema":{"type":"number","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"List of templates created in the workspace\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateList"}}}}},"tags":["Templates"]}},"/v1/templates/{id}":{"get":{"operationId":"template-get-one","summary":"Retrieve a template","description":"Returns information about the specified template.\n\n---\n\n#### See also \nLearn more about [Templates](./templates-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the template","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n "},"404":{"description":"No template can be found."}},"tags":["Templates"]}},"/v1/templates/run":{"post":{"operationId":"template-run-template","summary":"Run a template","description":"Run template attach on a Case.\n\n---\n\n#### See also \nLearn more about [Templates](./templates-guide) \nLearn more about [Cases](./cases-guide) \n","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunTemplate"}}}},"responses":{"201":{"description":"**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateExecution"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the body payload matches the expected schema\n "}},"tags":["Templates"]}},"/v1/cases/{id}/share-client-portal-link":{"post":{"operationId":"client-portal-share-client-portal-link","summary":"Share client portal link","description":"Generate an authenticated link to access a client portal for a business contact.\n\n---\n\n#### See also \nLearn more about [Cases](./cases-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the case","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientPortalShareLink"}}}},"responses":{"201":{"description":"**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientPortalShareLinkResponse"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n - Make sure the body payload matches the expected schema\n - Make sure that the client portal is online\n - If `business_contact_id` is specified, the individual must belong to the case, be relevant, and have an email address. If not already a business contact, they will be marked as one\n - If `business_contact_id` is not specified, the case must have a business contact\n "},"404":{"description":"No case, client portal or business contact can be found."}},"tags":["Client portal"]}},"/v1/cases/{id}/complete-client-portal-wait-step":{"post":{"operationId":"client-portal-complete-client-portal-wait-step","summary":"Complete client portal wait step","description":"On a case in `draft` status, mark wait steps of client portal as completed\n\n---\n\n#### See also \nLearn more about [Cases](./cases-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the case","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteClientPortalWaitStepInput"}}}},"responses":{"200":{"description":"**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteClientPortalWaitStepResponse"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n - Make sure the body payload matches the expected schema\n - Case status is not `draft`\n "},"404":{"description":"No case can be found."}},"tags":["Client portal"]}},"/v1/client-portals":{"get":{"operationId":"client-portal-get-many","summary":"Return a list of all client portals","description":"#### See also \nLearn more about [Client portals](./client-portals-guide) \n","parameters":[{"name":"name","required":false,"in":"query","description":"Filter items by the `name.{operator}` field. \nYou can use the `eq`, `not_eq`, `like` and `ilike` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter items by the `status.{operator}` field. \nYou can use the `eq`, `not_eq`, `in` and `not_in` operators, the `eq` operator being the default. \nComma separated for multiple values (`in` and `not_in`).","schema":{"type":"string","enum":["offline","online"]}},{"name":"default_language","required":false,"in":"query","description":"Filter items by the `default_language.{operator}` field. \nYou can use the `eq`, `not_eq`, `like` and `ilike` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"created_at","required":false,"in":"query","description":"Filter items by the `created_at.{operator}` field. \nYou can use the `eq`, `not_eq`, `gt`, `gte`, `lt` and `lte` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"updated_at","required":false,"in":"query","description":"Filter items by the `updated_at.{operator}` field. \nYou can use the `eq`, `not_eq`, `gt`, `gte`, `lt` and `lte` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"sort","required":false,"in":"query","description":"Use this parameter to sort query results. \nIf not specified, sorted in _ascending_ order with values of field `created_at`. \nAvailable fields are `created_at`.","schema":{"default":"created_at","type":"string"},"examples":{"created_at":{"summary":"Sort by values of the \"created_at\" field in ascending order","value":"created_at"},"created_at_descending":{"summary":"Sort by values of the \"created_at\" field in descending order","value":"created_at.desc"}}},{"name":"page","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose which page you want to display. \nPage index starts at 1 (the default).","schema":{"default":1,"type":"number","minimum":1}},{"name":"limit","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose the number of items per page. \nLimit defaults to 20, maximum value is 100.","schema":{"type":"number","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"List of client portals in the workspace\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientPortalList"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter.\n - If specified, make sure the value of the `page` or `limit` query parameter are valid.\n - Value of the `sort` parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.\n "}},"tags":["Client portal"]}},"/v1/tables":{"get":{"operationId":"table-get-many","summary":"List tables","description":"List all tables defined in your workspace\n\n---\n\n#### See also \nLearn more about [Tables](./tables-guide) \n","parameters":[],"responses":{"200":{"description":"List of tables\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableList"}}}}},"tags":["Tables"]}},"/v1/tables/{id}":{"get":{"operationId":"table-get-one","summary":"Retrieve a table","description":"Returns a table with it's entries\n\n---\n\n#### See also \nLearn more about [Tables](./tables-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Retrieve a table by its `key` first and if not found, by its Dotfile internal `id`.","examples":{"key":{"summary":"by key","value":"my-table-id"},"id":{"summary":"by id","value":"bf05e8f6-f909-487b-bb49-d58354c2c45c"}},"schema":{"type":"string"}}],"responses":{"200":{"description":"**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableDetailed"}}}},"404":{"description":"No table can be found."}},"tags":["Tables"]}},"/v1/custom-properties/{target_entity}":{"get":{"operationId":"custom-property-get-custom-properties","summary":"List custom properties per entity type","description":"Returns a paginated list of custom properties for a given entity type. Options are not included in this list; use the detail endpoint to retrieve options.\n\n","parameters":[{"name":"target_entity","required":true,"in":"path","description":"Entity type to retrieve custom properties for.","schema":{"enum":["case","company","individual"],"type":"string"}},{"name":"label","required":false,"in":"query","description":"Filter items by the `label.{operator}` field. \nYou can use the `eq`, `not_eq`, `like` and `ilike` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"key","required":false,"in":"query","description":"Filter items by the `key.{operator}` field. \nYou can use the `eq`, `not_eq`, `like` and `ilike` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"include_archived","required":false,"in":"query","description":"Include archived custom properties. \nDefault is false","schema":{"type":"boolean"}},{"name":"created_at","required":false,"in":"query","description":"Filter items by the `created_at.{operator}` field. \nYou can use the `eq`, `not_eq`, `gt`, `gte`, `lt` and `lte` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"updated_at","required":false,"in":"query","description":"Filter items by the `updated_at.{operator}` field. \nYou can use the `eq`, `not_eq`, `gt`, `gte`, `lt` and `lte` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"sort","required":false,"in":"query","description":"Use this parameter to sort query results. \nIf not specified, sorted in _ascending_ order with values of field `created_at`. \nAvailable fields are `created_at`, `key` and `label`.","schema":{"default":"created_at","type":"string"},"examples":{"created_at":{"summary":"Sort by values of the \"created_at\" field in ascending order","value":"created_at"},"key":{"summary":"Sort by values of the \"key\" field in descending order","value":"key.desc"},"label":{"summary":"Sort by values of the \"label\" field in ascending order","value":"label"},"multiple":{"summary":"Sort by values of multiple fields","value":"created_at,key.desc"}}},{"name":"page","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose which page you want to display. \nPage index starts at 1 (the default).","schema":{"default":1,"type":"number","minimum":1}},{"name":"limit","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose the number of items per page. \nLimit defaults to 20, maximum value is 100.","schema":{"type":"number","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"List of custom properties for entity type\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPropertyList"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter.\n - If specified, make sure the value of the `page` or `limit` query parameter are valid.\n - Value of the `sort` parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.\n "}},"tags":["Custom properties"]}},"/v1/custom-properties/{target_entity}/{key}":{"get":{"operationId":"custom-property-get-custom-property","summary":"Get a custom property detail for a given entity type","description":"Returns a list of all custom properties in your dotfile workspace for a given entity type\n\n","parameters":[{"name":"target_entity","required":true,"in":"path","description":"Entity type to retrieve custom properties for.","schema":{"enum":["case","company","individual"],"type":"string"}},{"name":"key","required":true,"in":"path","description":"The custom property key","schema":{"example":"last_audit","type":"string"}}],"responses":{"200":{"description":"Detailed custom property\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomPropertyBoolean","title":"Boolean"},{"$ref":"#/components/schemas/CustomPropertyChoicesWithOptions","title":"Choices"},{"$ref":"#/components/schemas/CustomPropertyCountries","title":"Countries"},{"$ref":"#/components/schemas/CustomPropertyDate","title":"Date"},{"$ref":"#/components/schemas/CustomPropertyEmail","title":"Email"},{"$ref":"#/components/schemas/CustomPropertyNumeric","title":"Numeric"},{"$ref":"#/components/schemas/CustomPropertyPhoneNumber","title":"Phone number"},{"$ref":"#/components/schemas/CustomPropertyText","title":"Text"},{"$ref":"#/components/schemas/CustomPropertyUrl","title":"URL"}],"discriminator":{"propertyName":"type","mapping":{"boolean":"#/components/schemas/CustomPropertyBoolean","choices":"#/components/schemas/CustomPropertyChoicesWithOptions","countries":"#/components/schemas/CustomPropertyCountries","date":"#/components/schemas/CustomPropertyDate","email":"#/components/schemas/CustomPropertyEmail","numeric":"#/components/schemas/CustomPropertyNumeric","phone_number":"#/components/schemas/CustomPropertyPhoneNumber","text":"#/components/schemas/CustomPropertyText","url":"#/components/schemas/CustomPropertyUrl"}}}}}},"404":{"description":"No custom property can be found."}},"tags":["Custom properties"]}},"/v1/users":{"get":{"operationId":"user-get-many","summary":"List all users","description":"Returns users in your Dotfile workspace. By default, only active users are returned. If you need suspended users, you can set the `include_suspended` query parameter to \"true\".\n\n---\n\n#### See also \nLearn more about [Filtering, Sorting and Pagination](./filtering-sorting-and-pagination) \n","parameters":[{"name":"include_suspended","required":false,"in":"query","description":"Whether suspended users should be included or not in the response","schema":{"type":"boolean"}},{"name":"page","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose which page you want to display. \nPage index starts at 1 (the default).","schema":{"default":1,"type":"number","minimum":1}},{"name":"limit","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose the number of items per page. \nLimit defaults to 20, maximum value is 100.","schema":{"type":"number","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"List of users in the workspace\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedUserList"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n\n "}},"tags":["Users"]}},"/v1/users/{id}":{"get":{"operationId":"user-get-one","summary":"Retrieve an user","description":"Returns information about the specified user.\n\n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the user","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"No user can be found."}},"tags":["Users"]}},"/v1/webhooks":{"get":{"operationId":"webhook-get-many","summary":"List all webhooks","description":"Returns a list of all the webhooks endpoints registered to your Dotfile workspace.\n\n---\n\n#### See also \nLearn more about [Webhooks](./webhooks-guide) \nLearn more about [Filtering, Sorting and Pagination](./filtering-sorting-and-pagination) \n","parameters":[{"name":"name","required":false,"in":"query","description":"Filter items by the `name.{operator}` field. \nYou can use the `eq`, `not_eq`, `like` and `ilike` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"created_at","required":false,"in":"query","description":"Filter items by the `created_at.{operator}` field. \nYou can use the `eq`, `not_eq`, `gt`, `gte`, `lt` and `lte` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"updated_at","required":false,"in":"query","description":"Filter items by the `updated_at.{operator}` field. \nYou can use the `eq`, `not_eq`, `gt`, `gte`, `lt` and `lte` operators, the `eq` operator being the default.","schema":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,3})?(Z|([0-9]{2}:[0-9]{2}))?)?$","example":["2023-01-31","2023-01-31T13:30:00Z","2023-01-31T13:30:00.000Z"],"description":"Date (`yyyy-MM-dd` eg `2023-01-31`) or date time (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`) in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}},{"name":"status","required":false,"in":"query","description":"Filter items by the `status.{operator}` field. \nYou can use the `eq` and `not_eq` operators, the `eq` operator being the default.","schema":{"type":"string","enum":["online","offline"]}},{"name":"type","required":false,"in":"query","description":"Filter items by the `type.{operator}` field. \nYou can use the `eq` and `not_eq` operators, the `eq` operator being the default.","schema":{"type":"string","enum":["user","system"]}},{"name":"url","required":false,"in":"query","description":"Filter items by the `url.{operator}` field. \nYou can use the `eq`, `not_eq`, `like` and `ilike` operators, the `eq` operator being the default.","schema":{"type":"string"}},{"name":"events","required":false,"in":"query","description":"Filter items by the `events.{operator}` field. \nYou can use the `array_contains`, `array_not_contains` and `array_overlap` operators, the `array_contains` operator being the default. \nComma separated for multiple values (`array_contains`, `array_not_contains` and `array_overlap`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"Use this parameter to sort query results. \nIf not specified, sorted in _ascending_ order with values of field `updated_at`. \nAvailable fields are `created_at`, `name`, `status`, `type`, `updated_at` and `url`.","schema":{"default":"updated_at","type":"string"},"examples":{"created_at":{"summary":"Sort by values of the \"created_at\" field in ascending order","value":"created_at"},"name":{"summary":"Sort by values of the \"name\" field in descending order","value":"name.desc"},"status":{"summary":"Sort by values of the \"status\" field in ascending order","value":"status"},"type":{"summary":"Sort by values of the \"type\" field in descending order","value":"type.desc"},"updated_at":{"summary":"Sort by values of the \"updated_at\" field in ascending order","value":"updated_at"},"url":{"summary":"Sort by values of the \"url\" field in descending order","value":"url.desc"},"multiple":{"summary":"Sort by values of multiple fields","value":"created_at,name.desc"}}},{"name":"page","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose which page you want to display. \nPage index starts at 1 (the default).","schema":{"default":1,"type":"number","minimum":1}},{"name":"limit","required":false,"in":"query","description":"Query response is paginated. \nUse this parameter to choose the number of items per page. \nLimit defaults to 20, maximum value is 100.","schema":{"type":"number","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"List of webhooks registered with the workspace\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookList"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - One or multiple filtering parameters might be malformed. Make sure to use a supported operator and value for each filter.\n - If specified, make sure the value of the `page` or `limit` query parameter are valid.\n - Value of the `sort` parameter is invalid. Make sure the field name is supported, the sorting order is correctly specified, and a same field is not used multiple times for sorting.\n "}},"tags":["Webhooks"]},"post":{"operationId":"webhook-create-one","summary":"Create a webhook","description":"Registers a new webhook endpoint.\n\n---\n\n#### See also \nLearn more about [Webhooks](./webhooks-guide) \n","callbacks":{"Case.ClientPortalWaitStepTriggered":{"{$request.body#/url}":{"post":{"operationId":"Case.ClientPortalWaitStepTriggered","summary":"Called on event `Case.ClientPortalWaitStepTriggered`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.Created":{"{$request.body#/url}":{"post":{"operationId":"Case.Created","summary":"Called on event `Case.Created`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.ReviewConfirmed":{"{$request.body#/url}":{"post":{"operationId":"Case.ReviewConfirmed","summary":"Called on event `Case.ReviewConfirmed`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.ReviewDue":{"{$request.body#/url}":{"post":{"operationId":"Case.ReviewDue","summary":"Called on event `Case.ReviewDue`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.ReviewUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.ReviewUpdated","summary":"Called on event `Case.ReviewUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.Updated":{"{$request.body#/url}":{"post":{"operationId":"Case.Updated","summary":"Called on event `Case.Updated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.AssigneeUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.AssigneeUpdated","summary":"Called on event `Case.AssigneeUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.ContactHasActionsUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.ContactHasActionsUpdated","summary":"Called on event `Case.ContactHasActionsUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.FlagsUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.FlagsUpdated","summary":"Called on event `Case.FlagsUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.InfoUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.InfoUpdated","summary":"Called on event `Case.InfoUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.MetadataUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.MetadataUpdated","summary":"Called on event `Case.MetadataUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.ReviewerHasActionsUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.ReviewerHasActionsUpdated","summary":"Called on event `Case.ReviewerHasActionsUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.RiskUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.RiskUpdated","summary":"Called on event `Case.RiskUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.StatusUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.StatusUpdated","summary":"Called on event `Case.StatusUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.TagsUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.TagsUpdated","summary":"Called on event `Case.TagsUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.TemplateUpdated":{"{$request.body#/url}":{"post":{"operationId":"Case.TemplateUpdated","summary":"Called on event `Case.TemplateUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Case.Deleted":{"{$request.body#/url}":{"post":{"operationId":"Case.Deleted","summary":"Called on event `Case.Deleted`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDeletedWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"CaseReport.Generated":{"{$request.body#/url}":{"post":{"operationId":"CaseReport.Generated","summary":"Called on event `CaseReport.Generated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseReportWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Note.Created":{"{$request.body#/url}":{"post":{"operationId":"Note.Created","summary":"Called on event `Note.Created`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Note.Deleted":{"{$request.body#/url}":{"post":{"operationId":"Note.Deleted","summary":"Called on event `Note.Deleted`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Note.Updated":{"{$request.body#/url}":{"post":{"operationId":"Note.Updated","summary":"Called on event `Note.Updated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"NoteComment.Created":{"{$request.body#/url}":{"post":{"operationId":"NoteComment.Created","summary":"Called on event `NoteComment.Created`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteCommentWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"NoteComment.Deleted":{"{$request.body#/url}":{"post":{"operationId":"NoteComment.Deleted","summary":"Called on event `NoteComment.Deleted`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteCommentWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"NoteComment.Updated":{"{$request.body#/url}":{"post":{"operationId":"NoteComment.Updated","summary":"Called on event `NoteComment.Updated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteCommentWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Individual.Created":{"{$request.body#/url}":{"post":{"operationId":"Individual.Created","summary":"Called on event `Individual.Created`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Individual.Updated":{"{$request.body#/url}":{"post":{"operationId":"Individual.Updated","summary":"Called on event `Individual.Updated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Individual.InfoUpdated":{"{$request.body#/url}":{"post":{"operationId":"Individual.InfoUpdated","summary":"Called on event `Individual.InfoUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Individual.MarkedAsNotRelevant":{"{$request.body#/url}":{"post":{"operationId":"Individual.MarkedAsNotRelevant","summary":"Called on event `Individual.MarkedAsNotRelevant`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Individual.MarkedAsRelevant":{"{$request.body#/url}":{"post":{"operationId":"Individual.MarkedAsRelevant","summary":"Called on event `Individual.MarkedAsRelevant`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Individual.Deleted":{"{$request.body#/url}":{"post":{"operationId":"Individual.Deleted","summary":"Called on event `Individual.Deleted`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndividualDeletedWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Company.Created":{"{$request.body#/url}":{"post":{"operationId":"Company.Created","summary":"Called on event `Company.Created`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Company.Updated":{"{$request.body#/url}":{"post":{"operationId":"Company.Updated","summary":"Called on event `Company.Updated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Company.InfoUpdated":{"{$request.body#/url}":{"post":{"operationId":"Company.InfoUpdated","summary":"Called on event `Company.InfoUpdated`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Company.MarkedAsNotRelevant":{"{$request.body#/url}":{"post":{"operationId":"Company.MarkedAsNotRelevant","summary":"Called on event `Company.MarkedAsNotRelevant`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Company.MarkedAsRelevant":{"{$request.body#/url}":{"post":{"operationId":"Company.MarkedAsRelevant","summary":"Called on event `Company.MarkedAsRelevant`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Company.Deleted":{"{$request.body#/url}":{"post":{"operationId":"Company.Deleted","summary":"Called on event `Company.Deleted`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDeletedWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Check.Started":{"{$request.body#/url}":{"post":{"operationId":"Check.Started","summary":"Called on event `Check.Started`","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AmlCheckWebhook","title":"AML Check Webhook"},{"$ref":"#/components/schemas/CompanyMonitoringCheckWebhook","title":"Company Monitoring Check Webhook"},{"$ref":"#/components/schemas/DocumentCheckWebhook","title":"Document Check Webhook"},{"$ref":"#/components/schemas/EkycCheckWebhook","title":"eKYC Check Webhook"},{"$ref":"#/components/schemas/ElectronicSignatureCheckWebhook","title":"Electronic Signature Check Webhook"},{"$ref":"#/components/schemas/FraudDatabaseCheckWebhook","title":"Fraud Database Check Webhook"},{"$ref":"#/components/schemas/IdDocumentCheckWebhook","title":"Identity Document Check Webhook"},{"$ref":"#/components/schemas/IdVerificationCheckWebhook","title":"Identity Verification Check Webhook"},{"$ref":"#/components/schemas/OnlineReputationCheckWebhook","title":"Online Reputation Check Webhook"}]}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Check.ReviewNeeded":{"{$request.body#/url}":{"post":{"operationId":"Check.ReviewNeeded","summary":"Called on event `Check.ReviewNeeded`","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AmlCheckWebhook","title":"AML Check Webhook"},{"$ref":"#/components/schemas/CompanyMonitoringCheckWebhook","title":"Company Monitoring Check Webhook"},{"$ref":"#/components/schemas/DocumentCheckWebhook","title":"Document Check Webhook"},{"$ref":"#/components/schemas/EkycCheckWebhook","title":"eKYC Check Webhook"},{"$ref":"#/components/schemas/ElectronicSignatureCheckWebhook","title":"Electronic Signature Check Webhook"},{"$ref":"#/components/schemas/FraudDatabaseCheckWebhook","title":"Fraud Database Check Webhook"},{"$ref":"#/components/schemas/IdDocumentCheckWebhook","title":"Identity Document Check Webhook"},{"$ref":"#/components/schemas/IdVerificationCheckWebhook","title":"Identity Verification Check Webhook"},{"$ref":"#/components/schemas/OnlineReputationCheckWebhook","title":"Online Reputation Check Webhook"}]}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Check.Approved":{"{$request.body#/url}":{"post":{"operationId":"Check.Approved","summary":"Called on event `Check.Approved`","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AmlCheckWebhook","title":"AML Check Webhook"},{"$ref":"#/components/schemas/CompanyMonitoringCheckWebhook","title":"Company Monitoring Check Webhook"},{"$ref":"#/components/schemas/DocumentCheckWebhook","title":"Document Check Webhook"},{"$ref":"#/components/schemas/EkycCheckWebhook","title":"eKYC Check Webhook"},{"$ref":"#/components/schemas/ElectronicSignatureCheckWebhook","title":"Electronic Signature Check Webhook"},{"$ref":"#/components/schemas/FraudDatabaseCheckWebhook","title":"Fraud Database Check Webhook"},{"$ref":"#/components/schemas/IdDocumentCheckWebhook","title":"Identity Document Check Webhook"},{"$ref":"#/components/schemas/IdVerificationCheckWebhook","title":"Identity Verification Check Webhook"},{"$ref":"#/components/schemas/OnlineReputationCheckWebhook","title":"Online Reputation Check Webhook"}]}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Check.Rejected":{"{$request.body#/url}":{"post":{"operationId":"Check.Rejected","summary":"Called on event `Check.Rejected`","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AmlCheckWebhook","title":"AML Check Webhook"},{"$ref":"#/components/schemas/CompanyMonitoringCheckWebhook","title":"Company Monitoring Check Webhook"},{"$ref":"#/components/schemas/DocumentCheckWebhook","title":"Document Check Webhook"},{"$ref":"#/components/schemas/EkycCheckWebhook","title":"eKYC Check Webhook"},{"$ref":"#/components/schemas/ElectronicSignatureCheckWebhook","title":"Electronic Signature Check Webhook"},{"$ref":"#/components/schemas/FraudDatabaseCheckWebhook","title":"Fraud Database Check Webhook"},{"$ref":"#/components/schemas/IdDocumentCheckWebhook","title":"Identity Document Check Webhook"},{"$ref":"#/components/schemas/IdVerificationCheckWebhook","title":"Identity Verification Check Webhook"},{"$ref":"#/components/schemas/OnlineReputationCheckWebhook","title":"Online Reputation Check Webhook"}]}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Check.Expired":{"{$request.body#/url}":{"post":{"operationId":"Check.Expired","summary":"Called on event `Check.Expired`","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AmlCheckWebhook","title":"AML Check Webhook"},{"$ref":"#/components/schemas/CompanyMonitoringCheckWebhook","title":"Company Monitoring Check Webhook"},{"$ref":"#/components/schemas/DocumentCheckWebhook","title":"Document Check Webhook"},{"$ref":"#/components/schemas/EkycCheckWebhook","title":"eKYC Check Webhook"},{"$ref":"#/components/schemas/ElectronicSignatureCheckWebhook","title":"Electronic Signature Check Webhook"},{"$ref":"#/components/schemas/FraudDatabaseCheckWebhook","title":"Fraud Database Check Webhook"},{"$ref":"#/components/schemas/IdDocumentCheckWebhook","title":"Identity Document Check Webhook"},{"$ref":"#/components/schemas/IdVerificationCheckWebhook","title":"Identity Verification Check Webhook"},{"$ref":"#/components/schemas/OnlineReputationCheckWebhook","title":"Online Reputation Check Webhook"}]}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"Check.Deleted":{"{$request.body#/url}":{"post":{"operationId":"Check.Deleted","summary":"Called on event `Check.Deleted`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDeletedWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"DocumentOrder.Completed":{"{$request.body#/url}":{"post":{"operationId":"DocumentOrder.Completed","summary":"Called on event `DocumentOrder.Completed`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentOrderWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}},"DocumentOrder.Failed":{"{$request.body#/url}":{"post":{"operationId":"DocumentOrder.Failed","summary":"Called on event `DocumentOrder.Failed`","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentOrderWebhook"}}}},"responses":{"200":{"description":"Your server returns this code if it accepts the callback"}}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreate"}}}},"responses":{"201":{"description":"The created webhook\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the body payload matches the expected schema\n - Maximum items reached (default: 50). Contact us at support@dotfile.com if you need more items.\n "}},"tags":["Webhooks"]}},"/v1/webhooks/{id}":{"get":{"operationId":"webhook-get-one","summary":"Retrieve a webhook","description":"Retrieves the webhook endpoint with the given ID.\n\n---\n\n#### See also \nLearn more about [Webhooks](./webhooks-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the webhook","schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"A webhook registered with the workspace\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n "},"404":{"description":"No webhook can be found."}},"tags":["Webhooks"]},"patch":{"operationId":"webhook-update-one","summary":"Update a webhook","description":"Updates the webhook endpoint.\n\n---\n\n#### See also \nLearn more about [Webhooks](./webhooks-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the webhook","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdate"}}}},"responses":{"200":{"description":"The updated webhook\n\n**ℹ️ Click to see full payload**","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n - Make sure the body payload matches the expected schema\n "},"404":{"description":"No webhook can be found."}},"tags":["Webhooks"]},"delete":{"operationId":"webhook-delete-one","summary":"Delete a webhook","description":"Deletes the webhook endpoint.\n\n---\n\n#### See also \nLearn more about [Webhooks](./webhooks-guide) \n","parameters":[{"name":"id","required":true,"in":"path","description":"Id of the webhook","schema":{"format":"uuid","type":"string"}}],"responses":{"204":{"description":"Webhook has been deleted"},"400":{"description":"The request is either malformed or contain invalid parameters.\n\n - Make sure the identifier specified in the URL is a valid UUID\n "},"404":{"description":"No webhook can be found."}},"tags":["Webhooks"]}}},"info":{"title":"⚙️ API specifications","description":"Dotfile public API documentation","version":"v1","contact":{}},"tags":[],"servers":[{"url":"https://api.dotfile.com","description":"Production environment"}],"components":{"securitySchemes":{"DotfileAPIKey":{"type":"apiKey","in":"header","name":"X-DOTFILE-API-KEY","description":"Configure your api key in the Workspace settings"}},"schemas":{"Ping":{"type":"object","properties":{"workspace_name":{"type":"string"}},"required":["workspace_name"]},"Risk":{"type":"object","properties":{"id":{"type":"string"},"mode":{"type":"string","enum":["automatic","manual"]},"level":{"type":"string","enum":["not_defined","low","medium","high","critical","prohibited"]},"comment":{"type":"string","nullable":true},"score":{"type":"number","nullable":true},"components":{"type":"object","nullable":true,"additionalProperties":{"type":"number"},"description":"Object in a format of `key` (string) / `value` (number)"},"flags":{"type":"object","nullable":true,"additionalProperties":{"type":"boolean"},"description":"Object in a format of `key` (string) / `value` (boolean)"},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","mode","level","comment","score","components","flags","created_at","updated_at"]},"NestedUser":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"}},"required":["id","first_name","last_name","email"]},"CaseReview":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["approved","rejected","closed"]},"comment":{"type":"string","nullable":true},"reviewer_type":{"type":"string","enum":["user","system","api"]},"user":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/NestedUser"}]},"reviewed_at":{"type":"string","format":"date-time","description":"Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"next_review_at":{"type":"string","format":"date","description":"Next review date. `null` if no review schedule after this one. \nDate in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)","nullable":true}},"required":["id","status","comment","reviewer_type","user","reviewed_at","next_review_at"]},"TemplateLight":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"key":{"type":"string"}},"required":["id","name","key"]},"CaseList":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string","enum":["draft","open","approved","rejected","closed"]},"review":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/CaseReview"}]},"external_id":{"type":"string","nullable":true},"assignee_id":{"type":"string","nullable":true},"template":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TemplateLight"}]},"template_id":{"type":"string","format":"uuid","nullable":true,"deprecated":true,"description":"Prefer using `template.key` instead."},"contact_has_actions":{"type":"boolean"},"reviewer_has_actions":{"type":"boolean"},"risk":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Risk"}]},"metadata":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Object in a format of `key` (string) / `value` (string)"},"last_activity_at":{"type":"string","format":"date-time","description":"Latest activity date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"last_contact_action_at":{"type":"string","format":"date-time","description":"Latest contact action date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)","nullable":true},"flags":{"type":"array","description":"`all_checks_approved` `for_review` `for_first_collect` `for_recollection` `first_collect_completed`","items":{"type":"string","enum":["all_checks_approved","for_review","for_first_collect","for_recollection","first_collect_completed"]}},"tags":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","name","status","review","external_id","assignee_id","template","template_id","contact_has_actions","reviewer_has_actions","risk","metadata","last_activity_at","last_contact_action_at","flags","tags","created_at","updated_at"]},"Pagination":{"type":"object","properties":{"page":{"type":"number","description":"Current page number (defined in query parameter)","default":1},"limit":{"type":"number","description":"Item count per page (defined in query parameter)","default":20},"count":{"type":"number","description":"Total items count","example":42}},"required":["page","limit","count"]},"PaginatedCaseList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CaseList"}},"pagination":{"example":{"page":1,"limit":20,"count":42},"allOf":[{"$ref":"#/components/schemas/Pagination"}]}},"required":["data","pagination"]},"PartialAddress":{"type":"object","properties":{"street_address":{"type":"string","nullable":true},"street_address_2":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"}}},"CompanyClassification":{"type":"object","properties":{"type":{"type":"string"},"code":{"type":"string"},"description":{"type":"string","nullable":true}},"required":["type","code"]},"BankingInformation":{"type":"object","properties":{"iban":{"type":"string","nullable":true,"minLength":15,"maxLength":34,"example":"FR7630006000011234567890189","description":"[ISO 13616](https://en.wikipedia.org/wiki/International_Bank_Account_Number) IBAN (eg: `FR7630006000011234567890189`).\nSpaces will be removed and value upper-cased."},"bic":{"type":"string","nullable":true,"minLength":8,"maxLength":12,"example":"AGRIFRPPXXX","description":"[ISO 9362](https://en.wikipedia.org/wiki/ISO_9362) BIC (eg: `AGRIFRPPXXX`).\nSpaces will be removed and value upper-cased."}},"required":["iban","bic"]},"CaseRelationCreateWithRef":{"type":"object","properties":{"voting_rights_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"ownership_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"position":{"type":"string","nullable":true},"source_company_ref":{"type":"string","description":"Reference to the source company within the same payload.\nUse the `ref` value of the company this relation comes FROM.\nWhen omitted, defaults to the main company of the case."}}},"CompanyCreateInput":{"type":"object","properties":{"name":{"type":"string","description":"Name for the company (at most 160 characters).","maxLength":160,"minLength":1},"type":{"type":"string","enum":["main","affiliated"],"default":"main"},"commercial_name":{"type":"string","nullable":true,"description":"Commercial name for the company (at most 160 characters).","maxLength":160,"minLength":1},"registration_number":{"type":"string","nullable":true},"registration_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"status":{"type":"string","enum":["live","closed","not_reported"],"default":"not_reported"},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"address":{"default":{},"allOf":[{"$ref":"#/components/schemas/PartialAddress"}]},"classifications":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CompanyClassification"}},"banking_information":{"$ref":"#/components/schemas/BankingInformation"},"share_capital":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"website_url":{"type":"string","nullable":true},"employer_identification_number":{"type":"string","nullable":true},"custom_properties":{"type":"object","description":"Optional partial custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to create the company. \n\nArchived custom properties are not accepted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"To remove the value for this custom property on the company"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"ref":{"type":"string","description":"Unique reference identifier within this request payload.\nUse this to reference the company from other entities (e.g., in `source_company_ref` of relations).\nCan be any unique string (e.g., \"main-co\", \"holding-1\")."},"relations":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CaseRelationCreateWithRef"}}},"required":["name"]},"IndividualCreateInput":{"type":"object","properties":{"first_name":{"type":"string"},"middle_name":{"type":"string","description":"May contain multiple middle names","nullable":true},"last_name":{"type":"string"},"maiden_name":{"type":"string","nullable":true},"is_business_contact":{"type":"boolean","default":false,"description":"Set to `true` if this individual should be contacted regarding the case, this will also make the `email` required."},"is_beneficial_owner":{"type":"boolean","default":false,"description":"Set to true if this individual ultimately owns or controls the main company"},"is_delegator":{"type":"boolean","default":false,"description":"Set to true if this individual is delegating its signing authority to the signatory of the case. \nIndividual cannot be both delegator and signatory \nNot relevant individual cannot be delegator"},"is_signatory":{"type":"boolean","default":false,"description":"Set to true if this person has delegated authority to be a signatory of the case, this will also make the `email` required. \nIndividual cannot be both signatory and delegator \nNot relevant individual cannot be signatory"},"email":{"type":"string","nullable":true,"description":"Required if individual `is_business_contact` is `true`. \nMust be a valid email as defined in the [HTML spec](https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address) (eg. must match the following JavaScript-compatible regular expression: ```/^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/```)","format":"email"},"birth_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"birth_country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"birth_place":{"type":"string","nullable":true},"address":{"default":{},"allOf":[{"$ref":"#/components/schemas/PartialAddress"}]},"banking_information":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BankingInformation"}]},"tax_identification_number":{"type":"string","nullable":true},"social_security_number":{"type":"string","nullable":true},"phone_number":{"type":"string","format":"e.164","minLength":10,"maxLength":15,"example":"+33601234567","nullable":true,"description":"[E.164](https://en.wikipedia.org/wiki/E.164) phoneNumber (eg `+XXXXXXXXXXX`)"},"position":{"type":"string","nullable":true},"ownership_percentage":{"type":"number","nullable":true,"minimum":0,"maximum":100},"voting_rights_percentage":{"type":"number","nullable":true,"minimum":0,"maximum":100},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"custom_properties":{"type":"object","description":"Optional partial custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to create the individual. \n\nArchived custom properties are not accepted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"To remove the value for this custom property on the individual"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"ref":{"type":"string","description":"Unique reference identifier within this request payload.\nUse this to reference the individual from other entities in the same payload.\nCan be any unique string (e.g., \"john-doe\", \"ceo-1\")."},"relations":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CaseRelationCreateWithRef"}}},"required":["first_name","last_name"]},"CaseCreate":{"type":"object","properties":{"name":{"type":"string","description":"Name for the case (at most 180 characters).","maxLength":180,"minLength":1},"status":{"type":"string","enum":["draft","open"],"default":"open","description":"Optional status for this case, Defaults to `open`.\n To set the status to `approved`, `rejected` or `closed`, use the [Create a case review](./case-review-create-one) endpoint."},"external_id":{"type":"string","description":"Optional external id for this case. You can use that to reference an entity of your system. Must be unique if set."},"template_key":{"type":"string","description":"Optional template key to attach template to this case.","nullable":true},"template_id":{"type":"string","format":"uuid","description":"Prefer using `template_key` instead. \nOptional template id to attach template to this case. Cannot be set at the same time as `template_key`.","nullable":true,"deprecated":true},"assignee_id":{"type":"string","format":"uuid","description":"Optional assignee id to assign a user to this case.","nullable":true},"metadata":{"type":"object","nullable":true,"description":"Optional metadata in a format of `key` (string) / `value` (string) for this case.","additionalProperties":{"type":"string"},"example":{"custom_key":"true","my_data":"this is important","count":"42"}},"custom_properties":{"type":"object","description":"Optional partial custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to create the case. \n\nArchived custom properties are not accepted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"To remove the value for this custom property on the case"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"tags":{"nullable":true,"description":"Optional tags for this case. Either tag `id`, or tag `label`. Tag labels are case insensitive","example":["High risk","8468f8e0-1067-4099-b8c3-824ae8b7204e"],"type":"array","items":{"type":"string"}},"companies":{"default":[],"description":"Optional array of companies to create within this case.\nEach company can reference other companies in the same payload using the `ref` field.\nAt least one company with `type: main` is expected if companies are provided.","type":"array","items":{"$ref":"#/components/schemas/CompanyCreateInput"}},"individuals":{"default":[],"description":"Optional array of individuals to create within this case.\nIndividuals can reference companies in the same payload using `source_company_ref` in their relations.","type":"array","items":{"$ref":"#/components/schemas/IndividualCreateInput"}}},"required":["name"]},"Review":{"type":"object","properties":{"comment":{"type":"string","nullable":true},"reviewed_at":{"type":"string","format":"date-time","nullable":true,"description":"Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"reviewer_type":{"type":"string","enum":["user","system","api"],"nullable":true},"user":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/NestedUser"}]}},"required":["comment","reviewed_at","reviewer_type","user"]},"Control":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"key":{"type":"string"},"type":{"type":"string","enum":["manual","automatic_logic","automatic_code"]},"archived_at":{"type":"string","format":"date-time","description":"Archive date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)","nullable":true}},"required":["id","label","key","type","archived_at"]},"CaseControl":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"is_completed":{"type":"boolean"},"review":{"$ref":"#/components/schemas/Review"},"control":{"$ref":"#/components/schemas/Control"},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","is_completed","review","control","created_at","updated_at"]},"Address":{"type":"object","properties":{"street_address":{"type":"string","nullable":true},"street_address_2":{"type":"string","nullable":true},"postal_code":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"}},"required":["street_address","street_address_2","postal_code","city","state","region","country"]},"Check":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"individual_id":{"type":"string","nullable":true},"company_id":{"type":"string","nullable":true},"is_internal":{"type":"boolean"},"status":{"type":"string","enum":["in_progress","need_review","processing","approved","rejected","expired"],"description":"ℹ️ Check status `expired` is deprecated and will be removed Q1'25. It will be replaced with an expired flag."},"type":{"type":"string","enum":["id_verification","id_document","aml","company_monitoring","document","ekyc","electronic_signature","fraud_database","online_reputation"]},"subtype":{"type":"string","nullable":true,"description":"Contains the `subtype` for some check `type`: \n- `document`: Currently contains `\"document_type:{document_type_key}\"` \n- `electronic_signature`: Contains `\"document_template:{document_template_key}\"` \n- For all other check type, always contains `null`"},"document_type_key":{"type":"string","description":"Set only for `document` Check with the document type key."},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"last_activity_at":{"type":"string","format":"date-time","description":"Latest activity date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","individual_id","company_id","is_internal","status","type","subtype","created_at","updated_at","last_activity_at"]},"CaseRelationOfEntity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"to_company_id":{"type":"string","format":"uuid"},"voting_rights_percentage":{"type":"number","format":"float","nullable":true},"ownership_percentage":{"type":"number","format":"float","nullable":true},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"position":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","to_company_id","voting_rights_percentage","ownership_percentage","roles","position","created_at","updated_at"]},"Individual":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"case_id":{"type":"string","format":"uuid"},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"is_beneficial_owner":{"type":"boolean","description":"Set to true if this individual ultimately owns or controls the main company"},"is_business_contact":{"type":"boolean","description":"Set to true if this individual should be contacted regarding the case"},"is_delegator":{"type":"boolean","description":"Set to true if this individual is delegating its signing authority to the signatory of the case"},"is_signatory":{"type":"boolean","description":"Set to true if this person has delegated authority to be a signatory of the case"},"is_relevant":{"type":"boolean"},"first_name":{"type":"string"},"middle_name":{"type":"string","description":"May contain multiple middle names","nullable":true},"last_name":{"type":"string"},"maiden_name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true,"format":"email"},"birth_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"birth_country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"birth_place":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/Address"},"banking_information":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BankingInformation"}]},"tax_identification_number":{"type":"string","nullable":true},"social_security_number":{"type":"string","nullable":true},"phone_number":{"type":"string","format":"e.164","minLength":10,"maxLength":15,"example":"+33601234567","nullable":true,"description":"Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`) \n[E.164](https://en.wikipedia.org/wiki/E.164) phoneNumber (eg `+XXXXXXXXXXX`)"},"position":{"type":"string","nullable":true},"ownership_percentage":{"type":"number","format":"float","nullable":true},"voting_rights_percentage":{"type":"number","format":"float","nullable":true},"custom_properties":{"type":"object","description":"Custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to read the individual. \n\nArchived custom properties are omitted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"When there are no value for this custom property on the individual"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"checks":{"type":"array","items":{"$ref":"#/components/schemas/Check"}},"relations":{"type":"array","items":{"$ref":"#/components/schemas/CaseRelationOfEntity"}},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"last_activity_at":{"type":"string","format":"date-time","description":"Latest activity date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","case_id","roles","is_beneficial_owner","is_business_contact","is_delegator","is_signatory","is_relevant","first_name","middle_name","last_name","maiden_name","email","birth_date","birth_country","birth_place","address","banking_information","tax_identification_number","social_security_number","phone_number","position","ownership_percentage","voting_rights_percentage","custom_properties","checks","relations","created_at","updated_at","last_activity_at"]},"DocumentOrder":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"company_id":{"type":"string","format":"uuid"},"product_ref":{"type":"string"},"name":{"type":"string"},"price_tier":{"type":"string"},"status":{"type":"string","enum":["created","processing","completed","failed"]},"file_id":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","company_id","product_ref","name","price_tier","status","file_id","created_at","updated_at"]},"Company":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"case_id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["main","affiliated"]},"name":{"type":"string","maxLength":160},"is_relevant":{"type":"boolean"},"commercial_name":{"type":"string","nullable":true,"maxLength":160},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"registration_number":{"type":"string","nullable":true,"maxLength":180},"registration_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"status":{"type":"string","enum":["live","closed","not_reported"],"default":"not_reported"},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"entity_legal_form_label":{"type":"string","readOnly":true,"description":"Label in the origin country language of the [ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code. \nMay contains multiple labels separated with a comma `,` when the code is assigned to multiple label in different languages.","nullable":true},"address":{"$ref":"#/components/schemas/Address"},"classifications":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/CompanyClassification"}},"banking_information":{"$ref":"#/components/schemas/BankingInformation"},"share_capital":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"website_url":{"type":"string","nullable":true},"employer_identification_number":{"type":"string","nullable":true},"custom_properties":{"type":"object","description":"Custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to read the company. \n\nArchived custom properties are omitted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"When there are no value for this custom property on the company"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"document_orders":{"type":"array","items":{"$ref":"#/components/schemas/DocumentOrder"}},"checks":{"type":"array","items":{"$ref":"#/components/schemas/Check"}},"relations":{"type":"array","items":{"$ref":"#/components/schemas/CaseRelationOfEntity"}},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"last_activity_at":{"type":"string","format":"date-time","description":"Latest activity date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","case_id","type","name","is_relevant","commercial_name","country","registration_number","registration_date","status","legal_form","entity_legal_form","entity_legal_form_label","address","classifications","banking_information","share_capital","tax_identification_number","website_url","employer_identification_number","custom_properties","document_orders","checks","relations","created_at","updated_at","last_activity_at"]},"CaseClientPortal":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string","enum":["KYB","KYC"]},"wait_step_key":{"type":"string","nullable":true,"description":"Set when a contact reaches and triggers a `wait` step of this client portal, which will also emit a `ClientPortal.ClientPortalWaitStepTriggered` webhook event.\nYou then need to release the `wait` step using [Complete client portal wait step](./client-portal-complete-client-portal-wait-step) to allow the contact to continue the client portal forms"}},"required":["id","name","type","wait_step_key"]},"CaseCreateResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string","enum":["draft","open","approved","rejected","closed"]},"review":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/CaseReview"}]},"external_id":{"type":"string","nullable":true},"template":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TemplateLight"}]},"template_id":{"type":"string","format":"uuid","nullable":true,"deprecated":true,"description":"Prefer using `template.key` instead."},"contact_has_actions":{"type":"boolean"},"reviewer_has_actions":{"type":"boolean"},"flags":{"type":"array","description":"`all_checks_approved` `for_review` `for_first_collect` `for_recollection` `first_collect_completed`","items":{"type":"string","enum":["all_checks_approved","for_review","for_first_collect","for_recollection","first_collect_completed"]}},"tags":{"type":"array","items":{"type":"string"}},"risk":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Risk"}]},"custom_properties":{"type":"object","description":"Custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to read the case. \n\nArchived custom properties are omitted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"When there are no value for this custom property on the case"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"metadata":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Object in a format of `key` (string) / `value` (string)"},"last_activity_at":{"type":"string","format":"date-time","description":"Latest activity date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"last_contact_action_at":{"type":"string","format":"date-time","description":"Latest contact action date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)","nullable":true},"controls":{"type":"array","items":{"$ref":"#/components/schemas/CaseControl"}},"individuals":{"type":"array","items":{"$ref":"#/components/schemas/Individual"}},"companies":{"type":"array","items":{"$ref":"#/components/schemas/Company"}},"assignee":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/NestedUser"}]},"assignee_id":{"type":"string","nullable":true,"deprecated":true,"description":"The user id of the assignee of the case. `null` if not assigned. \n\nPrefer to use `assignee.id` instead."},"client_portal":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/CaseClientPortal"}]},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","name","status","review","external_id","template","template_id","contact_has_actions","reviewer_has_actions","flags","tags","risk","custom_properties","metadata","last_activity_at","last_contact_action_at","controls","individuals","companies","assignee","assignee_id","client_portal","created_at","updated_at"]},"CaseDetailed":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string","enum":["draft","open","approved","rejected","closed"]},"review":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/CaseReview"}]},"external_id":{"type":"string","nullable":true},"template":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TemplateLight"}]},"template_id":{"type":"string","format":"uuid","nullable":true,"deprecated":true,"description":"Prefer using `template.key` instead."},"contact_has_actions":{"type":"boolean"},"reviewer_has_actions":{"type":"boolean"},"flags":{"type":"array","description":"`all_checks_approved` `for_review` `for_first_collect` `for_recollection` `first_collect_completed`","items":{"type":"string","enum":["all_checks_approved","for_review","for_first_collect","for_recollection","first_collect_completed"]}},"tags":{"type":"array","items":{"type":"string"}},"risk":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Risk"}]},"custom_properties":{"type":"object","description":"Custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to read the case. \n\nArchived custom properties are omitted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"When there are no value for this custom property on the case"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"metadata":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Object in a format of `key` (string) / `value` (string)"},"last_activity_at":{"type":"string","format":"date-time","description":"Latest activity date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"last_contact_action_at":{"type":"string","format":"date-time","description":"Latest contact action date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)","nullable":true},"controls":{"type":"array","items":{"$ref":"#/components/schemas/CaseControl"}},"individuals":{"type":"array","items":{"$ref":"#/components/schemas/Individual"}},"companies":{"type":"array","items":{"$ref":"#/components/schemas/Company"}},"assignee":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/NestedUser"}]},"client_portal":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/CaseClientPortal"}]},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","name","status","review","external_id","template","template_id","contact_has_actions","reviewer_has_actions","flags","tags","risk","custom_properties","metadata","last_activity_at","last_contact_action_at","controls","individuals","companies","assignee","client_portal","created_at","updated_at"]},"CaseUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Update the name of the case (at most 180 characters).","maxLength":180,"minLength":1},"status":{"type":"string","enum":["draft","open"],"description":"Update the status of the case to `draft` or `open`.\n To set the status to `approved`, `rejected` or `closed`, use the [Create a case review](./case-review-create-one) endpoint."},"external_id":{"type":"string","description":"Update the external id of the case. Must be unique if set. Set to `null` to clear it."},"template_key":{"type":"string","description":"Update the template of the case using template key. Set to `null` to detach template.","nullable":true},"template_id":{"type":"string","format":"uuid","description":"Prefer using `template_key` instead. \nUpdate the template of the case. Set to `null` to detach template. Cannot be set at the same time as `template_key`.","nullable":true,"deprecated":true},"assignee_id":{"type":"string","format":"uuid","description":"Update the user assignee of the case. Set to `null` to un-assign.","nullable":true},"custom_properties":{"type":"object","description":"Optional partial custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to update the case. \n\nArchived custom properties are not accepted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"To remove the value for this custom property on the case"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"metadata":{"type":"object","nullable":true,"description":"Update all the metadata in a format of `key` (string) / `value` (string) of the case. Set to `null` to remove all metadata.","additionalProperties":{"type":"string"},"example":{"custom_key":"true","my_data":"this is important","count":"42"}}}},"Case":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string","enum":["draft","open","approved","rejected","closed"]},"review":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/CaseReview"}]},"external_id":{"type":"string","nullable":true},"assignee_id":{"type":"string","nullable":true},"template":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/TemplateLight"}]},"template_id":{"type":"string","format":"uuid","nullable":true,"deprecated":true,"description":"Prefer using `template.key` instead."},"contact_has_actions":{"type":"boolean"},"reviewer_has_actions":{"type":"boolean"},"flags":{"type":"array","description":"`all_checks_approved` `for_review` `for_first_collect` `for_recollection` `first_collect_completed`","items":{"type":"string","enum":["all_checks_approved","for_review","for_first_collect","for_recollection","first_collect_completed"]}},"tags":{"type":"array","items":{"type":"string"}},"risk":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/Risk"}]},"custom_properties":{"type":"object","description":"Custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to read the case. \n\nArchived custom properties are omitted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"When there are no value for this custom property on the case"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"metadata":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Object in a format of `key` (string) / `value` (string)"},"last_activity_at":{"type":"string","format":"date-time","description":"Latest activity date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"last_contact_action_at":{"type":"string","format":"date-time","description":"Latest contact action date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)","nullable":true},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","name","status","review","external_id","assignee_id","template","template_id","contact_has_actions","reviewer_has_actions","flags","tags","risk","custom_properties","metadata","last_activity_at","last_contact_action_at","created_at","updated_at"]},"NoteComment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"note_id":{"type":"string","format":"uuid","description":"Comment's note id"},"content":{"type":"string","description":"HTML content"},"author":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/NestedUser"}]},"author_type":{"type":"string","enum":["user","api"]},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","note_id","content","author","author_type","created_at","updated_at"]},"Note":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"case_id":{"type":"string","format":"uuid","description":"Note's case id"},"content":{"type":"string","description":"HTML content"},"comments":{"description":"Maximum of 50 comments per note.","type":"array","items":{"$ref":"#/components/schemas/NoteComment"}},"author":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/NestedUser"}]},"author_type":{"type":"string","enum":["user","api"]},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","case_id","content","comments","author","author_type","created_at","updated_at"]},"CaseNotePaginateList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Note"}},"pagination":{"example":{"page":1,"limit":20,"count":42},"allOf":[{"$ref":"#/components/schemas/Pagination"}]}},"required":["data","pagination"]},"CaseDocumentDocumentOrder":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"CaseDocumentCheck":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"subtype":{"type":"string","nullable":true,"description":"Contains the `subtype` for some check `type`: \n- `document`: Currently contains `\"document_type:{document_type_key}\"` \n- `electronic_signature`: Contains `\"document_template:{document_template_key}\"` \n- For all other check type, always contains `null`"},"document_type_key":{"type":"string","description":"Set only for `document` Check with the document type key."},"type":{"type":"string","enum":["document","id_document","id_verification","electronic_signature"]},"version":{"type":"string","enum":["current","history"]}},"required":["id","subtype","type","version"]},"CaseDocument":{"type":"object","properties":{"company_id":{"type":"string"},"individual_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["case_report","document_order","check__document","check__id_document","check__id_verification","check__electronic_signature"]},"document_order":{"$ref":"#/components/schemas/CaseDocumentDocumentOrder"},"check":{"$ref":"#/components/schemas/CaseDocumentCheck"},"file_ids":{"description":"Use the [Download a file](./file-get-file) operation to retrieve each files","type":"array","items":{"type":"string"}},"updated_at":{"type":"string","format":"date-time","description":"Latest update date of the files \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["name","type","file_ids","updated_at"]},"CaseDocumentList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CaseDocument"}}},"required":["data"]},"CaseReportParams":{"type":"object","properties":{"timezone":{"type":"string","default":"Europe/Paris","description":"Only accepts TZ identifier. Refer to https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for TZ database values."}}},"CaseReviewApprovedCreate":{"type":"object","properties":{"status":{"type":"string","enum":["approved"]},"comment":{"type":"string","description":"May be **required** depending on your workspace settings"},"reviewed_at":{"type":"string","format":"date-time","description":"Optional review date, will default to current time if not set. Useful to anti-date a review \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"next_review_at":{"type":"string","format":"date","description":"Computed by default from your workspace settings and the case risk level by default but optionally override the next review date for this case, with `null` to force not date (no next review scheduled). \nDate in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)","nullable":true}},"required":["status"]},"CaseReviewRejectedCreate":{"type":"object","properties":{"status":{"type":"string","enum":["rejected"]},"comment":{"type":"string","description":"May be **required** depending on your workspace settings"},"reviewed_at":{"type":"string","format":"date-time","description":"Optional review date, will default to current time if not set. Useful to anti-date a review \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["status"]},"CaseReviewClosedCreate":{"type":"object","properties":{"status":{"type":"string","enum":["closed"]},"comment":{"type":"string","description":"May be **required** depending on your workspace settings"},"reviewed_at":{"type":"string","format":"date-time","description":"Optional review date, will default to current time if not set. Useful to anti-date a review \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["status"]},"RiskCreate":{"type":"object","properties":{"level":{"type":"string","enum":["not_defined","low","medium","high","critical","prohibited"]},"score":{"type":"number","format":"integer","maximum":2147483647,"minimum":-2147483648},"components":{"type":"object","additionalProperties":{"type":"number","maximum":2147483647,"minimum":-2147483648},"example":{"customer_score":1400,"product_score":3000,"delivery_channel_score":2000,"transaction_score":1667,"geography_score":2000}},"flags":{"type":"object","additionalProperties":{"type":"boolean"},"example":{"prohibited_country_ubo":true,"complex_company_alert":false}}},"required":["level"]},"CaseRelationCreateCompanyTarget":{"type":"object","properties":{"from_company_id":{"type":"string","format":"uuid"},"to_company_id":{"type":"string","format":"uuid","description":"When omitted, will default to the `main` company of the case"},"voting_rights_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"ownership_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"position":{"type":"string","nullable":true}},"required":["from_company_id"]},"CaseRelationCreateIndividualTarget":{"type":"object","properties":{"from_individual_id":{"type":"string","format":"uuid"},"to_company_id":{"type":"string","format":"uuid","description":"When omitted, will default to the `main` company of the case"},"voting_rights_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"ownership_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"position":{"type":"string","nullable":true}},"required":["from_individual_id"]},"CaseRelation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"from_company_id":{"type":"string","format":"uuid","nullable":true},"from_individual_id":{"type":"string","format":"uuid","nullable":true},"to_company_id":{"type":"string","format":"uuid"},"voting_rights_percentage":{"type":"number","format":"float","nullable":true},"ownership_percentage":{"type":"number","format":"float","nullable":true},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"position":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","from_company_id","from_individual_id","to_company_id","voting_rights_percentage","ownership_percentage","roles","position","created_at","updated_at"]},"CaseRelationUpdate":{"type":"object","properties":{"voting_rights_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"ownership_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"position":{"type":"string","nullable":true},"to_company_id":{"type":"string","format":"uuid"}}},"Country":{"type":"object","properties":{"code":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"example":"FR","description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"name":{"type":"string","example":"France"},"localName":{"type":"string","example":"France"},"emoji":{"type":"string","example":"🇫🇷"},"emojiCode":{"type":"string","example":"1F1EB 1F1F7"},"vendor":{"type":"string","enum":["pappers","kompany","creditsafe","kyckr","companies_house","inpi","info_camere","transparenzregister","topograph","charity_commission","none"],"example":"pappers"}},"required":["code","name","localName","emoji","emojiCode","vendor"]},"CountryList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Country"}}},"required":["data"]},"EntityLegalForm":{"type":"object","properties":{"code":{"type":"string","example":"8MEC","description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"example":"CA","nullable":true,"description":"`null` for legal entity form available to all countries \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"subdivision":{"type":"string","example":"CA-NB","description":"Country subdivision"},"label":{"type":"string","description":"Label in the origin country language of the [ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code. \nMay contains multiple labels separated with a comma `,` when the code is assigned to multiple label in different languages."},"languages":{"type":"object","example":{"fr":{"label":"Société à responsabilité limitée du Nouveau-Brunswick","abbreviations":[]},"en":{"label":"New Brunswick limited liability partnership","abbreviations":["LLP"]}}}},"required":["code","country","label","languages"]},"EntityLegalFormList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EntityLegalForm"}}},"required":["data"]},"CompanySearch":{"type":"object","properties":{"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"name":{"type":"string"},"search_ref":{"type":"string","description":"Opaque string, use it to fetch the information of this company via [Fetch company data](./company-data-fetch)"},"registration_number":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"disclosable":{"type":"boolean","description":"When `false`, indicate that the company information is not fully publicly available. Company data fetch will be partial"},"status":{"type":"string","description":"Company status (live, closed, not_reported)","enum":["live","closed","not_reported"]}},"required":["country","name","search_ref","registration_number","address","disclosable","status"]},"CompanySearchList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CompanySearch"}}},"required":["data"]},"IndividualBeneficialOwner":{"type":"object","properties":{"entity_type":{"type":"string","enum":["individual"]},"name":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"position":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"middle_name":{"type":"string","description":"May contain multiple middle names","nullable":true},"last_name":{"type":"string","nullable":true},"maiden_name":{"type":"string","nullable":true},"birth_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"birth_country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"birth_place":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"voting_rights_percentage":{"type":"number","format":"float","nullable":true},"ownership_percentage":{"type":"number","format":"float","nullable":true}},"required":["entity_type","name","address","position","first_name","middle_name","last_name","maiden_name","birth_date","birth_country","birth_place","tax_identification_number","voting_rights_percentage","ownership_percentage"]},"CompanyBeneficialOwner":{"type":"object","properties":{"entity_type":{"type":"string","enum":["company"]},"name":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"position":{"type":"string","nullable":true},"registration_number":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"entity_legal_form_label":{"type":"string","readOnly":true,"description":"Label in the origin country language of the [ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code. \nMay contains multiple labels separated with a comma `,` when the code is assigned to multiple label in different languages.","nullable":true},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"ownership_percentage":{"type":"number","format":"float","nullable":true}},"required":["entity_type","name","address","position","registration_number","tax_identification_number","legal_form","entity_legal_form","entity_legal_form_label","country","ownership_percentage"]},"IndividualShareholder":{"type":"object","properties":{"entity_type":{"type":"string","enum":["individual"]},"name":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"position":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"middle_name":{"type":"string","description":"May contain multiple middle names","nullable":true},"last_name":{"type":"string","nullable":true},"maiden_name":{"type":"string","nullable":true},"birth_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"birth_country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"birth_place":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"voting_rights_percentage":{"type":"number","format":"float","nullable":true},"ownership_percentage":{"type":"number","format":"float","nullable":true}},"required":["entity_type","name","address","position","first_name","middle_name","last_name","maiden_name","birth_date","birth_country","birth_place","tax_identification_number","voting_rights_percentage","ownership_percentage"]},"CompanyShareholder":{"type":"object","properties":{"entity_type":{"type":"string","enum":["company"]},"name":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"position":{"type":"string","nullable":true},"registration_number":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"entity_legal_form_label":{"type":"string","readOnly":true,"description":"Label in the origin country language of the [ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code. \nMay contains multiple labels separated with a comma `,` when the code is assigned to multiple label in different languages.","nullable":true},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"ownership_percentage":{"type":"number","format":"float","nullable":true}},"required":["entity_type","name","address","position","registration_number","tax_identification_number","legal_form","entity_legal_form","entity_legal_form_label","country","ownership_percentage"]},"IndividualRepresentative":{"type":"object","properties":{"entity_type":{"type":"string","enum":["individual"]},"name":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"position":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"middle_name":{"type":"string","description":"May contain multiple middle names","nullable":true},"last_name":{"type":"string","nullable":true},"maiden_name":{"type":"string","nullable":true},"birth_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"birth_country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"birth_place":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"voting_rights_percentage":{"type":"number","format":"float","nullable":true}},"required":["entity_type","name","address","position","first_name","middle_name","last_name","maiden_name","birth_date","birth_country","birth_place","tax_identification_number","voting_rights_percentage"]},"CompanyRepresentative":{"type":"object","properties":{"entity_type":{"type":"string","enum":["company"]},"name":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"position":{"type":"string","nullable":true},"registration_number":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"entity_legal_form_label":{"type":"string","readOnly":true,"description":"Label in the origin country language of the [ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code. \nMay contains multiple labels separated with a comma `,` when the code is assigned to multiple label in different languages.","nullable":true},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"}},"required":["entity_type","name","address","position","registration_number","tax_identification_number","legal_form","entity_legal_form","entity_legal_form_label","country"]},"MergedIndividualRelation":{"type":"object","properties":{"voting_rights_percentage":{"type":"number","format":"float","nullable":true},"ownership_percentage":{"type":"number","format":"float","nullable":true},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"position":{"type":"string","nullable":true}},"required":["voting_rights_percentage","ownership_percentage","roles","position"]},"MergedCompanyRelation":{"type":"object","properties":{"ownership_percentage":{"type":"number","format":"float","nullable":true},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"position":{"type":"string","nullable":true}},"required":["ownership_percentage","roles","position"]},"MergedIndividual":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"position":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"middle_name":{"type":"string","description":"May contain multiple middle names","nullable":true},"last_name":{"type":"string","nullable":true},"maiden_name":{"type":"string","nullable":true},"birth_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"birth_country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"birth_place":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"voting_rights_percentage":{"type":"number","format":"float","nullable":true},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"ownership_percentage":{"type":"number","format":"float","nullable":true},"is_beneficial_owner":{"type":"boolean"},"is_business_contact":{"type":"boolean"},"relations":{"type":"array","items":{"$ref":"#/components/schemas/MergedIndividualRelation"}}},"required":["address","position","first_name","middle_name","last_name","maiden_name","birth_date","birth_country","birth_place","tax_identification_number","voting_rights_percentage","roles","ownership_percentage","is_beneficial_owner","is_business_contact","relations"]},"MergedCompany":{"type":"object","properties":{"name":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"registration_number":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"type":{"type":"string","enum":["affiliated"]},"relations":{"type":"array","items":{"$ref":"#/components/schemas/MergedCompanyRelation"}}},"required":["name","address","registration_number","tax_identification_number","legal_form","entity_legal_form","country","type","relations"]},"CompanyData":{"type":"object","properties":{"name":{"type":"string"},"commercial_name":{"type":"string","nullable":true},"registration_number":{"type":"string"},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"status":{"type":"string","enum":["live","closed","not_reported"]},"registration_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"entity_legal_form_label":{"type":"string","readOnly":true,"description":"Label in the origin country language of the [ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code. \nMay contains multiple labels separated with a comma `,` when the code is assigned to multiple label in different languages.","nullable":true},"address":{"$ref":"#/components/schemas/Address"},"share_capital":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"website_url":{"type":"string","nullable":true},"classifications":{"type":"array","items":{"$ref":"#/components/schemas/CompanyClassification"}},"beneficial_owners":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/IndividualBeneficialOwner"},{"$ref":"#/components/schemas/CompanyBeneficialOwner"}]}},"shareholders":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/IndividualShareholder"},{"$ref":"#/components/schemas/CompanyShareholder"}]}},"legal_representatives":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/IndividualRepresentative"},{"$ref":"#/components/schemas/CompanyRepresentative"}]}},"merged_individuals":{"type":"array","items":{"$ref":"#/components/schemas/MergedIndividual"}},"merged_companies":{"type":"array","items":{"$ref":"#/components/schemas/MergedCompany"}}},"required":["name","commercial_name","registration_number","country","status","registration_date","legal_form","entity_legal_form","entity_legal_form_label","address","share_capital","tax_identification_number","website_url","classifications","beneficial_owners","shareholders","legal_representatives","merged_individuals","merged_companies"]},"AvailableDocument":{"type":"object","properties":{"name":{"type":"string","example":"Extrait INPI"},"product_ref":{"type":"string","example":"cGFwcGVycyxmcl9leHRyYWl0X2lucGk="},"vendor":{"type":"string","enum":["pappers","kyckr","companies_house","info_camere","transparenzregister","topograph"],"example":"pappers"},"price_tier":{"type":"string","example":"tier_0","enum":["tier_0","tier_1","tier_2","tier_3","tier_4","tier_5","tier_6","tier_7","tier_8","tier_9"]},"delivery":{"type":"string","example":"instant","enum":["instant","delayed"]},"delivery_time":{"type":"number","format":"integer","description":"In seconds. Unknown if null.","nullable":true,"example":0},"sample_url":{"type":"string","nullable":true}},"required":["name","product_ref","vendor","price_tier","delivery","delivery_time","sample_url"]},"AvailableDocumentList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AvailableDocument"}}},"required":["data"]},"DocumentOrderCreate":{"type":"object","properties":{"company_id":{"type":"string","format":"uuid"},"product_ref":{"type":"string","description":"Retrieve possible value from [List available documents](./company-data-available-documents)."}},"required":["company_id","product_ref"]},"CompanyList":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"case_id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["main","affiliated"]},"name":{"type":"string","maxLength":160},"is_relevant":{"type":"boolean"},"commercial_name":{"type":"string","nullable":true,"maxLength":160},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"registration_number":{"type":"string","nullable":true,"maxLength":180},"registration_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"status":{"type":"string","enum":["live","closed","not_reported"],"default":"not_reported"},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"entity_legal_form_label":{"type":"string","readOnly":true,"description":"Label in the origin country language of the [ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code. \nMay contains multiple labels separated with a comma `,` when the code is assigned to multiple label in different languages.","nullable":true},"address":{"$ref":"#/components/schemas/Address"},"classifications":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/CompanyClassification"}},"banking_information":{"$ref":"#/components/schemas/BankingInformation"},"share_capital":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"website_url":{"type":"string","nullable":true},"employer_identification_number":{"type":"string","nullable":true},"last_activity_at":{"type":"string","format":"date-time","description":"Latest activity date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"created_at":{"type":"string","format":"date-time","description":"Creation date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"},"updated_at":{"type":"string","format":"date-time","description":"Latest update date \nDate time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)"}},"required":["id","case_id","type","name","is_relevant","commercial_name","country","registration_number","registration_date","status","legal_form","entity_legal_form","entity_legal_form_label","address","classifications","banking_information","share_capital","tax_identification_number","website_url","employer_identification_number","last_activity_at","created_at","updated_at"]},"PaginatedCompanyList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CompanyList"}},"pagination":{"example":{"page":1,"limit":20,"count":42},"allOf":[{"$ref":"#/components/schemas/Pagination"}]}},"required":["data","pagination"]},"CaseRelationCreateImplicitTarget":{"type":"object","properties":{"to_company_id":{"type":"string","format":"uuid","description":"When omitted, will default to the `main` company of the case"},"voting_rights_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"ownership_percentage":{"type":"number","format":"float","nullable":true,"minimum":0,"maximum":100},"roles":{"type":"array","description":"`legal_representative` `shareholder`","items":{"type":"string","enum":["legal_representative","shareholder"]}},"position":{"type":"string","nullable":true}}},"CompanyCreate":{"type":"object","properties":{"name":{"type":"string","description":"Name for the company (at most 160 characters).","maxLength":160,"minLength":1},"type":{"type":"string","enum":["main","affiliated"],"default":"main"},"commercial_name":{"type":"string","nullable":true,"description":"Commercial name for the company (at most 160 characters).","maxLength":160,"minLength":1},"registration_number":{"type":"string","nullable":true},"registration_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"status":{"type":"string","enum":["live","closed","not_reported"],"default":"not_reported"},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"address":{"default":{},"allOf":[{"$ref":"#/components/schemas/PartialAddress"}]},"classifications":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CompanyClassification"}},"banking_information":{"$ref":"#/components/schemas/BankingInformation"},"share_capital":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"website_url":{"type":"string","nullable":true},"employer_identification_number":{"type":"string","nullable":true},"custom_properties":{"type":"object","description":"Optional partial custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to create the company. \n\nArchived custom properties are not accepted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"To remove the value for this custom property on the company"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}},"case_id":{"type":"string","format":"uuid","description":"Case id where the company is created"},"relations":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CaseRelationCreateImplicitTarget"}}},"required":["name","case_id"]},"CompanyUpdate":{"type":"object","properties":{"name":{"type":"string","description":"Name for the company (at most 160 characters).","maxLength":160,"minLength":1},"commercial_name":{"type":"string","nullable":true,"description":"Commercial name for the company (at most 160 characters).","maxLength":160,"minLength":1},"registration_number":{"type":"string","nullable":true},"registration_date":{"type":"string","format":"date","nullable":true,"description":"Date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)(`yyyy-MM-dd` eg `2023-01-31`)"},"status":{"type":"string","enum":["live","closed","not_reported"],"default":"not_reported"},"legal_form":{"type":"string","nullable":true},"entity_legal_form":{"type":"string","nullable":true,"description":"[ISO 20275](https://www.gleif.org/en/about-lei/iso-20275-entity-legal-forms-code-list) code (eg: `6CHY`)"},"country":{"type":"string","format":"alpha-2","minLength":2,"maxLength":2,"nullable":true,"description":"[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)"},"address":{"default":{},"allOf":[{"$ref":"#/components/schemas/PartialAddress"}]},"classifications":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/CompanyClassification"}},"banking_information":{"$ref":"#/components/schemas/BankingInformation"},"share_capital":{"type":"string","nullable":true},"tax_identification_number":{"type":"string","nullable":true},"website_url":{"type":"string","nullable":true},"employer_identification_number":{"type":"string","nullable":true},"custom_properties":{"type":"object","description":"Optional partial custom properties object in a format of `key` (string) / `value` (string | boolean | string[] | number | null) to update the company. \n\nArchived custom properties are not accepted.","additionalProperties":{"oneOf":[{"type":"string","description":"- For custom property `text`, maxLength depends on the settings `isMultiLine`. singleLine: maxLength=250, multiLine: maxLength=1500 \n\n- For custom property `email`, maxLength=250. \n\n- For custom property `url`, maxLength=2000 \n\n- For custom property `date`, date in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-dd` eg `2023-01-31`) \n\n- For custom property `phone_number`, phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format (eg `+33123456789`)","nullable":true},{"type":"boolean","description":"For custom property `boolean`","nullable":true},{"type":"number","nullable":true,"description":"For custom property `numeric`, actual minimum and maximum will depend on the property settings but will be within -9007199254740991 and 9007199254740991","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"array","description":"- For custom property `choices`, contains the `key` of the options \n\n- For custom property `countries`, contains the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code (eg `FR`)","items":{"type":"string"},"nullable":true},{"nullable":true,"description":"To remove the value for this custom property on the company"}]},"example":{"custom_text":"Custom properties text","custom_boolean":true,"custom_date":"2012-12-12","custom_countries":["FR"],"custom_choices":["option1","option2"],"custom_numeric":12.3,"custom_property":null}}}},"Pappers":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"company_id":{"type":"string","format":"uuid"},"name":{"type":"string","enum":["pappers"]},"raw":{"type":"object","description":"For **Pappers**, see` will be added if the content doesn't start with a `
` or a `
` will be added if the content doesn't start with a `
` or a `