### Get Webhook Configuration Example Request Source: https://docs.fenergox.com/developer-hub/event-notifications/webhook-api-walkthrough Example of a GET request to retrieve a specific webhook's configuration using its webhookId. ```HTTP GET https://{{baseURL}}/webhooks/v1/webhooks/7c98579e-6fb4-47e1-961b-89a6da0cf32a HTTP/1.1 ``` -------------------------------- ### Example Get Specific Lookup URL Source: https://docs.fenergox.com/developer-hub/journey-policy-and-entity-data/updating-entity-data-and-advancing-journeys An example of a GET request URL for retrieving a specific lookup, using a provided lookup ID. ```HTTP {{baseURL}}/lookupquery/api/lookup/69b06a0b-bfa8-4235-bc49-26647886d664 ``` -------------------------------- ### Example Read Back Legal Entity URL Source: https://docs.fenergox.com/developer-hub/journey-policy-and-entity-data/create-new-legal-entity An example of a GET request URL to retrieve a specific legal entity. ```text {{baseURL}}/entitydataquery/api/entity/2ed9f965-342a-4dc8-afb8-58b8de41cd5f ``` -------------------------------- ### Example Migration Artifacts API Request Source: https://docs.fenergox.com/developer-hub/data-migration/api-walkthrough An example of a GET request to retrieve artifacts for a specific migration. This shows how to structure the URL with a sample migration ID. ```HTTP {{baseURL}}/datamigrationquery/api/migration/a5261b21-2eee-45ce-b629-b53b6b5f1b81/get-artifacts ``` -------------------------------- ### HTTP GET Example to Read Company File Source: https://docs.fenergox.com/developer-hub/data-migration/api-walkthrough Example of an HTTP GET request to retrieve the content of a company file, specifically a sample template in CSV format. ```http {{baseURL}}/datamigrationquery/api/migration/a5261b21-2eee-45ce-b629-b53b6b5f1b81/get-artifact-content?type=sample-templates&name=Company&format=csv ``` -------------------------------- ### Example URL to Get Draft Entity Record Source: https://docs.fenergox.com/developer-hub/journey-policy-and-entity-data/updating-entity-data-and-advancing-journeys An example of a GET request URL to fetch a draft legal entity record using specific IDs. ```HTTP {{baseURL}}/entitydataquery/api/entity/2ed9f965-342a-4dc8-afb8-58b8de41cd5f/draft/0b588152-85ef-4223-908b-684214144541 ``` -------------------------------- ### Get Migrated Records File Signed URL API Example (V2) Source: https://docs.fenergox.com/developer-hub/data-migration/execute-a-migration Example of a GET request to obtain a signed URL for a large reconciliation file using the V2 Command API. ```HTTP GET {{baseURL}}/datamigrationcommand/api/v2/migration/a5261b21-2eee-45ce-b629-b53b6b5f1b81/migration-records-file-signed-url ``` -------------------------------- ### Launch Journey GET Response Example Source: https://docs.fenergox.com/developer-hub/journey-policy-and-entity-data/launch-journey-and-draft-entity This JSON response provides comprehensive details about the launched journeys and created entity drafts for a given business process. It includes the overall status, payload information, and a list of individual journey items with their respective statuses. ```json { "data": { "businessProcessId": "24511767-4586-4b69-af43-c405ec6b154a", "status": "In Progress", "payload": { "entityId": "58e4b43a-a082-49a6-bf79-0cf8df2313c6", "journeyType": "Client Onboarding" }, "created": "2025-01-05T14:48:00.000Z", "messages": [], "items": [ { "journeyId": "118313c6-91e6-4b05-a537-5a1ab906418f", "journeySchemaId": "a5cfd4e8-732f-4601-ac88-652b64c8439c", "journeySchemaVersionNumber": 1, "entityDraftId": "c7b9fd6f-cdea-46fb-ab9c-1006adc812a0", "journeyType": "Client Onboarding", "journeyName": "COB Journey", "status": "Done" }, { "journeyId": "77538ab0-5463-4dd3-b19d-ca631378a275", "journeySchemaId": "bf44f48e-3eff-40f3-a1e5-da389ab7aa9d", "journeySchemaVersionNumber": 1, "entityDraftId": "fed6a403-7a56-4d08-bbda-c34f1c0c35ee", "journeyType": "Client Onboarding", "journeyName": "COB Journey 2", "status": "In Progress" } ] }, "messages": [] } ``` -------------------------------- ### Data Migration - GET Artifacts Response Example Source: https://docs.fenergox.com/developer-hub/data-migration/api-walkthrough This JSON response lists the artifacts generated for a migration session. It includes CSV sample templates and an Excel schema reference file. ```JSON { "data": [ { "type": "sample-templates", "name": "Addresses", "format": "csv" }, { "type": "sample-templates", "name": "AssociationsToCompany", "format": "csv" }, { "type": "sample-templates", "name": "Company", "format": "csv" }, { "type": "sample-templates", "name": "Individual", "format": "csv" }, { "type": "sample-templates", "name": "Unique Identifiers", "format": "csv" }, { "type": "schema-references", "name": "fenx-data-migration-schema", "format": "xlsx" } ], "messages": null } ``` -------------------------------- ### Full Test Response Example Source: https://docs.fenergox.com/developer-hub/custom-external-adapters/custom-external-data-adapter/custom-external-data-adapter-configure-and-test A complete test response including ID, tenant, provider details, status, and the populated adapter schema with lookups. ```json { "Id": "254d60a5-756c-468d-ae2d-232f117e1ec8", "Tenant": "XXXXXXX-xxxx-xxxx-xxxx-XXXXXXXX", "ProviderId": "1968a450-e906-4654-844a-75ab43d91f34", "type": "Test", "status": "Success", "errorDetails": null, "response": { "adapterSchema": { "Lookups": [ { "Name": "CountryCodes", "Values": [ "IRL", "UK", "USA", "CAN" ] }, { "Name": "EntityType", ``` -------------------------------- ### Get Migrated Records API Example Source: https://docs.fenergox.com/developer-hub/data-migration/execute-a-migration Example of a GET request to retrieve migrated records using a specific migration ID. ```HTTP GET {{baseURL}}/datamigrationquery/api/migration/a5261b21-2eee-45ce-b629-b53b6b5f1b81/get-migrated-records-file ``` -------------------------------- ### Final Tenant Localisation Example (Supported Language) Source: https://docs.fenergox.com/user-guides/other-clm-functional-documentation-a-to-z/localisation-on-the-fenergo-platform Illustrates the final localized output when a tenant override file is used with a supported language master file. Overridden keys take tenant-specific values, while others default to the master file. ```json { "Material Data": "重要な材料", "Data Field": "データフィールド", "Entity Data": "エンティティデータ" } ``` -------------------------------- ### Final Tenant Localisation Example (Non-Translated Language) Source: https://docs.fenergox.com/user-guides/other-clm-functional-documentation-a-to-z/localisation-on-the-fenergo-platform Shows the final localized output for a non-supported language where the override file is incomplete. Missing keys default to English, while provided keys use the tenant-specific translation. ```json { "Material Data": "重要な材料", "Data Field": "", "Entity Data": "" } ``` -------------------------------- ### Per-Minute Limit Bucket Calculation Example Source: https://docs.fenergox.com/developer-hub/event-ingress/rate-limits Demonstrates how complexity points reduce the available points in a per-minute limit bucket. Shows the calculation after the first event and the resulting deficit after a second event is received within the same window. ```plaintext 1. As the first event is received we verify there are available points in the Limit Buckets. 3000 [per-minute Limit] - 2000 [Event #1 Points] = 1000 points remaining for a new minute window set to expire 60 seconds from now. 30000 [per-hour Limit] - 2000 [Event #1 Points] = 28000 points remaining for a new hourly window set to expire 60 minutes from now. 2. Assume the second event is sent back-to-back and will be received within the same minute window. 1000 [per-minute Limit] - 2000 [Event #2 Points] = -1000 points remaining for current minute window. 28000 [per-hour Limit] - 2000 [Event #2 Points] = 26000 points remaining for current hourly window. ``` -------------------------------- ### Tooltip Configuration Example Source: https://docs.fenergox.com/user-guides/essential-fenergo-saas-configuration-guides/configuring-the-fenergo-portal/configuring-user-guidance-in-the-portal Adds a tooltip icon and text within that tooltip. Any markdown-formatted text added below the line '[--tooltip--]' will display when the tooltip icon is activated. ```text [--tooltip--] This is a tooltip with Markdown ``` -------------------------------- ### Entity GUID Example Source: https://docs.fenergox.com/developer-hub/api-overview/api-quick-reference The GUID in the 'id' field represents an Entity Id. This is the response from a call to /entitydatacommand/api/v2/entity. ```json { "data": { "id": "7a400251-5800-4a4e-8da8-83e426f3740f" }, "messages": null } ``` -------------------------------- ### Example Usage of Policy Field Guidance Source: https://docs.fenergox.com/user-guides/essential-fenergo-saas-configuration-guides/configuring-the-fenergo-portal/configuring-user-guidance-in-the-portal This example demonstrates how to use Markdown to format rich, contextual guidance within a Policy Field in the Fenergo Portal. It includes headers, bold text, lists, and hyperlinks. ```markdown Thank you for choosing to bank with us! To help finalize your account setup quickly and securely, please provide the following documents. Having these documents ready will ensure a smooth verification process and get you started with your new account as soon as possible. #### Required Documents for Verification 1. **[Proof of Identity](https://www.yourbank.com/accepted-id-documents)** Please submit one of the following: - Government-issued ID (passport, driver’s license, national ID) - Birth certificate or social security card 2. **[Proof of Address](https://www.yourbank.com/address-proof-requirements)** To verify your residence, submit a recent (within the last 3 months) copy of: - Utility bill (water, electricity, etc.) - Bank statement or credit card statement - Lease agreement or mortgage statement 3. **[Income Verification (if applicable)](https://www.yourbank.com/income-verification)** If required, please provide one of the following documents: - Recent pay stubs or employment letter - Tax returns or bank statements showing regular deposits 4. **[Additional Documentation](https://www.yourbank.com/extra-documents)** Depending on your account type, other documents may be necessary. Our team will reach out if anything specific is needed. ## How to Upload Your Documents Please log in to the [Secure Upload Portal](https://www.yourbank.com/upload-documents) to submit your documents. If you have any questions about the documents listed, [contact us](https://www.yourbank.com/contact) for assistance. We appreciate your cooperation and look forward to completing your account setup soon! ``` -------------------------------- ### Example Journey Instance ID Request Source: https://docs.fenergox.com/developer-hub/journey-policy-and-entity-data/updating-entity-data-and-advancing-journeys An example of a GET request to the Journey Query API using a specific journey instance ID. This retrieves the detailed record for that journey. ```HTTP HTTP GET URL: ================ {{baseURL}}/journeyquery/api/journey-instance/5a516f2b-3a83-4c4f-a7bb-0a50763a19c6 ``` -------------------------------- ### Data Migration Get Artifacts Response Source: https://docs.fenergox.com/developer-hub/data-migration/migrating-products Example JSON response from the 'get artifacts' API call, listing various artifacts available for a migration, including CSV templates for Company, Individual, AssociationsToProduct, and Product. ```json { "data": [ . . . . . . {Other Artifacts} . . { "type": "sample-templates", "name": "Company", "format": "csv" }, { "type": "sample-templates", "name": "Individual", "format": "csv" }, { "type": "sample-templates", "name": "AssociationsToProduct", "format": "csv" }, . . . . . . {Other Artifacts} . . { "type": "sample-templates", "name": "Product", "format": "csv" }, . . . . . . {Other Artifacts} . . ], "messages": null } ``` -------------------------------- ### Fenergo System Default English Master File Example Source: https://docs.fenergox.com/user-guides/other-clm-functional-documentation-a-to-z/localisation-on-the-fenergo-platform Example of the Fenergo system's default English master file. This is used as a fallback when translations are missing in the tenant override file for non-supported languages. ```json { "Material Data" : "", "Data Field": "", "Entity Data": "" } ``` -------------------------------- ### Encrypted External Data Get Request Example Source: https://docs.fenergox.com/developer-hub/custom-external-adapters/custom-external-data-adapter/custom-external-data-adapter-implementation This is an example of an encrypted message sent from Fenergo to your hosted External Data Adapter to request a specific record. It includes HTTP headers and the encrypted HTTP body. ```text {HTTP HEADERS} x-encryption-iv 7iuDGwzhm0EYp9hkNE9Axw== x-authentication-mac r8NmvI7tb4bIsFDACJi8Tw3UJMRvC9XdjrRtO7Ue28Y= x-provider-id 1968a450-e906-4654-844a-75ab43d91f34 x-tenant-id XXXXXxxxxXXXXXxxxxxXXXXXXXXXxxxxxXXXX {HTTP BODY} lVw3OJezGHrhtnV2o2L/VzxNB1OrFi/axMX/DIMlk4PqmafuNzJPhb70BJ9/4XQPILcMDf/6qf6IUj3aLQBmvXy2VjUlGSoarFHoc2AAxlx77eLK8MPy8MzlzDOvAc6OGgjSo2Kwisno6Q60rhwY4enr3NaIbG7H+AGUuiqa/OGWrq3oOC64BTD4G7XKynf/6NRxJJA+yONUXzlfQpyuJ0IUzHqHdpxvqre833orE6eqpPfSzdqZKCmEJatrAJuFkeo71aEy1W2m2Oc+n/mjN8yHIlv302nDFsdLld/+sR2D0UOwM1Pfw6utWnxHdkt3RqW7Fztq9uy/nK90tkNsy1q2eWk2aBUqTPLE4p5cG7HCLyxqXHAsXdLXvg4mXlAT2MUQVjrE1chDtWKRnNBXGJxlzCPnSAamz5cFg4Zx9BGnL9smtZxoNNL6nMMDRSmFOKuJ2XUYycTka7RsXob8lg== ``` -------------------------------- ### Tenant Override JSON File Example Source: https://docs.fenergox.com/user-guides/other-clm-functional-documentation-a-to-z/localisation-on-the-fenergo-platform Example of a tenant-specific override JSON file. This file allows customization of translations for specific keys, overriding the master file. ```json { "Material Data": "重要な材料" } ``` -------------------------------- ### Journey Instance GUID Example Source: https://docs.fenergox.com/developer-hub/api-overview/api-quick-reference This response from /journeycommand/api/journey-instance includes a Journey Instance Id, Journey Schema Id, and an Entity Id. ```json { "data": { "journeyInstanceId": "9a6f6da0-5391-4342-8172-800b875764d2", "journeySchemaId": "da625c11-888d-4c08-8933-e9c8778a1d89", "entityId": "38827b19-f9df-41f8-8081-c3875ed532f2" }, "messages": null } ``` -------------------------------- ### Journey Resource Change Example Source: https://docs.fenergox.com/developer-hub/api-overview/audit-api-overview Illustrates the detailed structure for tracking changes within Journey resources, including stages, processes, and tasks, along with metadata. ```json "beforeValue": { "Stages": { "\u0022947d987e-2d4c-4642-b65a-7588f7a6e133\u0022": { "Processes": { "\u002242a21741-d6cb-41b5-a4a1-eb26becc4754\u0022": { "Tasks": { "\u0022ef6ccff3-9b2a-4a35-9535-3b94f9487b8a\u0022": { "Status": "In Progress", "Completed": "0001-01-01T00:00:00", "CompletedBy": null, "IsCompleted": false } } } } } }, "Version": 5 }, "afterValue": { "Stages": { "\u0022947d987e-2d4c-4642-b65a-7588f7a6e133\u0022": { "Processes": { "\u002242a21741-d6cb-41b5-a4a1-eb26becc4754\u0022": { "Tasks": { "\u0022ef6ccff3-9b2a-4a35-9535-3b94f9487b8a\u0022": { "Status": "Done", "Completed": "2021-10-08T12:07:54.7693637Z", "CompletedBy": "8866c334-e961-496c-992f-9372407a810f", "IsCompleted": true } } } } } }, "Version": 6, "metadata": { "Stages": [ { "Id": "947d987e-2d4c-4642-b65a-7588f7a6e133", "Name": "Screening", "Processes": [ { "Id": "42a21741-d6cb-41b5-a4a1-eb26becc4754", "Name": "New Request", "Tasks": [ { "Id": "ef6ccff3-9b2a-4a35-9535-3b94f9487b8a", "Name": "Basic Details" } ] } ] } ] } ```