{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-dataStudio/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"DataStudio API Endpoints"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"__idx":0,"id":"datastudio-api-endpoints"},"children":["DataStudio API Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The DataStudio API provides a comprehensive set of endpoints to help you manage and optimise your business portfolios."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Data Studio Suite provides a set of endpoints to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authenticate"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create, retrieve, update, and delete portfolios"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add, import, retrieve, and delete records within a portfolio"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Run advanced services such as matching, deduplication, and enrichment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve the status and results of asynchronous operations"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Below is a flow diagram guide on how to use these endpoints."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":1,"id":"flow-diagram-portfolio-management"},"children":["Flow Diagram: Portfolio Management"]},{"$$mdtype":"Tag","name":"Mermaid","attributes":{"data-language":"mermaid","diagramSource":"%%{ init: { \"theme\": \"default\" } }%%\nflowchart TD\n A[Authenticate]\n B[Create Portfolio]\n C[Add/Import Records]\n D[Retrieve Portfolio or Records]\n J[Delete Records or Portfolio]\n\n A --> B\n B --> C\n C --> D\n D --> J\n","diagramHtml":"
Authenticate
Create Portfolio
Add/Import Records
Retrieve Portfolio or Records
Delete Records or Portfolio
"},"children":["%%{ init: { \"theme\": \"default\" } }%%\nflowchart TD\n A[Authenticate]\n B[Create Portfolio]\n C[Add/Import Records]\n D[Retrieve Portfolio or Records]\n J[Delete Records or Portfolio]\n\n A --> B\n B --> C\n C --> D\n D --> J\n"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Diagram summary (accessibility): Authenticate, create a portfolio, add or import records, retrieve portfolio or record data, and then delete records or the portfolio when required."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":2,"id":"flow-diagram-portfolio-optimisation"},"children":["Flow Diagram: Portfolio Optimisation"]},{"$$mdtype":"Tag","name":"Mermaid","attributes":{"data-language":"mermaid","diagramSource":"%%{ init: { \"theme\": \"default\" } }%%\nflowchart TD\n D[Retrieve Portfolio or Records]\n E{Optimise Portfolio?}\n F[Run Matching Service]\n G[Run Deduplication Service]\n H[Run Enrichment Service]\n I[Retrieve Job Status/Results]\n\n D --> E\n E -- Yes --> F\n F --> G\n F --> H\n G --> I\n H --> I\n I --> D\n","diagramHtml":"
Yes
Retrieve Portfolio or Records
Optimise Portfolio?
Run Matching Service
Run Deduplication Service
Run Enrichment Service
Retrieve Job Status/Results
"},"children":["%%{ init: { \"theme\": \"default\" } }%%\nflowchart TD\n D[Retrieve Portfolio or Records]\n E{Optimise Portfolio?}\n F[Run Matching Service]\n G[Run Deduplication Service]\n H[Run Enrichment Service]\n I[Retrieve Job Status/Results]\n\n D --> E\n E -- Yes --> F\n F --> G\n F --> H\n G --> I\n H --> I\n I --> D\n"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Diagram summary (accessibility): From portfolio data retrieval, decide whether to optimize; if yes, run matching, then deduplication and/or enrichment, retrieve job status/results, and loop back to portfolio retrieval."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":3,"id":"1.-authenticate"},"children":["1. Authenticate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before using any of the endpoints, you must authenticate. This ensures you have the necessary permissions to access the data."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":4,"id":"example-request"},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/authenticate\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["NOTE"]},": All subsequent requests require a bearer token in the Authorization header."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":5,"id":"2.-portfolio-management"},"children":["2. Portfolio Management"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After authentication, you can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a new portfolio"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add or import records"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve or update portfolio details"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Portfolios are the core structure for organizing your business records."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":6,"id":"example-requests"},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"Create a Portfolio\nPOST /v1/datastudio/portfolios\n\nReturn Portfolio by Id \nGET /v1/datastudio/portfolios/{portfolioId}\n\nCreate Records in a Portfolio\nPOST /v1/datastudio/portfolios/{portfolioId}/records\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Example Requests:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/datastudio/datastudio/portfolio/createportfolio"},"children":["Create a portfolio"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/datastudio/datastudio/portfolio/getportfolio"},"children":["Retrieve portfolio by portfolio Id"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/datastudio/datastudio/portfolio-records/createrecords"},"children":["Create records"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":7,"id":"️-additional-notes-on-record-management"},"children":["⚙️ Additional Notes on Record Management"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":8,"id":"record-addition-limits"},"children":["Record Addition Limits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When adding records directly to a portfolio:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You can add ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["up to 300 records per request"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/datastudio/datastudio/portfolio-records/createrecords"},"children":["Create Records Endpoint Documentation"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":9,"id":"importing-records-via-csv"},"children":["Importing Records via CSV"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To bulk upload records:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Maximum file size: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["50 MB"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Supported formats: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["csv"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gzip"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tar"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gztar"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The first row must contain ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["headers"]}," that match the expected field names."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can find the full list of supported CSV headers and formatting guidance in the official documentation:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/datastudio/datastudio/portfolio-records-import/importrecords"},"children":["Import Records Endpoint Documentation"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":10,"id":"3.-portfolio-optimisation"},"children":["3. Portfolio Optimisation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once your portfolio is populated, you can use optimization endpoints to improve data quality and gain insights:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Matching:"]}," Link your records to Creditsafe’s unique company identifiers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Deduplication:"]}," Identify and resolve duplicate records."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enrichment:"]}," Enhance your records with additional company data."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each optimization service is asynchronous; you start a job and then poll for its status and results."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":11,"id":"4.-matching-deduplication-and-enrichment"},"children":["4. Matching, Deduplication, and Enrichment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If this is the first time your portfolio and its records are being processed, it is recommended to follow the steps in this order: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Matching → Deduplication → Enrichment"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":12,"id":"matching"},"children":["Matching"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Matching should be performed first. For best results, it is advised to match against the Creditsafe Safe Number."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Start the matching process:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Initiate matching using the relevant endpoint for your portfolio."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check matching status:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["executionId"]}," provided in the initial response to check the status of the matching process."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more details, refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/datastudio/datastudio/matching"},"children":["matching documentation"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":13,"id":"deduplication"},"children":["Deduplication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After matching, you can run deduplication to sanitise your data before enrichment. In the request body, you can specify how you want to identify duplicates."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Start the deduplication process:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /{apiVersion}/datastudio/portfolios/{portfolioId}/duplicates/identify"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This will begin the process of finding duplicates in your portfolio."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check deduplication status:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["executionId"]}," returned from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," request to check the status:",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /{apiVersion}/datastudio/portfolios/{portfolioId}/duplicates/{executionId}"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This endpoint will provide a link to a file containing all identified duplicates."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Remove duplicates:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Once duplicates are identified, run the removal process by passing the portfolio ID to the appropriate endpoint."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on deduplication, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/datastudio/datastudio/deduplication"},"children":["deduplication documentation"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":14,"id":"enrichment"},"children":["Enrichment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once deduplication is complete, you can use the enrichment process to enhance your records with additional data."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Start enrichment:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Pass the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["portfolioId"]}," in the path, set the enrichment type to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL_DATA_ENRICHMENT"]},", and provide a request body specifying the fields to enrich.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Details on the request body and available fields can be found in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://doc.creditsafe.com/datastudio/datastudio/enrichment/startenrichment"},"children":["enrichment documentation"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check enrichment status and retrieve results:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"After starting enrichment, you can check the status and retrieve the resulting file via a link provided in the response."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":15,"id":"5.-retrieve-job-status-and-results"},"children":["5. Retrieve Job Status and Results"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For asynchronous operations (matching, deduplication, enrichment), use the provided ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["executionId"]}," to check job status and retrieve results."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":16,"id":"example-request-1"},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/datastudio/portfolios/{portfolioId}/enrich/{executionId}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":17,"id":"6.-delete-records-or-portfolio"},"children":["6. Delete Records or Portfolio"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can remove individual records or delete entire portfolios as needed to keep your data organized and up-to-date."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete a portfolio:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"DELETE /{apiVersion}/datastudio/portfolios/{portfolioId}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete records from a portfolio:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /{apiVersion}/datastudio/portfolios/{portfolioId}/records/delete\n","lang":"http"},"children":[]}]},"headings":[{"value":"DataStudio API Endpoints","id":"datastudio-api-endpoints","depth":1},{"value":"Flow Diagram: Portfolio Management","id":"flow-diagram-portfolio-management","depth":2},{"value":"Flow Diagram: Portfolio Optimisation","id":"flow-diagram-portfolio-optimisation","depth":2},{"value":"1. Authenticate","id":"1.-authenticate","depth":2},{"value":"Example Request","id":"example-request","depth":3},{"value":"2. Portfolio Management","id":"2.-portfolio-management","depth":2},{"value":"Example Requests","id":"example-requests","depth":3},{"value":"⚙️ Additional Notes on Record Management","id":"️-additional-notes-on-record-management","depth":2},{"value":"Record Addition Limits","id":"record-addition-limits","depth":3},{"value":"Importing Records via CSV","id":"importing-records-via-csv","depth":3},{"value":"3. Portfolio Optimisation","id":"3.-portfolio-optimisation","depth":2},{"value":"4. Matching, Deduplication, and Enrichment","id":"4.-matching-deduplication-and-enrichment","depth":2},{"value":"Matching","id":"matching","depth":3},{"value":"Deduplication","id":"deduplication","depth":3},{"value":"Enrichment","id":"enrichment","depth":3},{"value":"5. Retrieve Job Status and Results","id":"5.-retrieve-job-status-and-results","depth":2},{"value":"Example Request","id":"example-request-1","depth":3},{"value":"6. Delete Records or Portfolio","id":"6.-delete-records-or-portfolio","depth":2}],"frontmatter":{"seo":{"title":"DataStudio API Endpoints"}},"lastModified":"2026-03-27T09:21:13.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/datastudio/documentation/management","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}