> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tic.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Credit Report

> Get a full credit report hosted on a temporary URL

This endpoint will create a fully hosted credit report (time limited) for the given company and
return the URL including incurred costs. You can post also a E.164 formatted mobile
phone number and we will send a text message including the full credit report to the user

Also you can add an e-mail address that will receive an e-mail containing the link
to the report.

Remember the model that you need to post needs at minimum contain ConsentToPricing set to true.

Example:

```json theme={null}
{
  "consentToPricing": true,
  "sendSMSToE164MobileNumber": "+46xxxxxx",
  "sendEmailToEmailAddress": "some@email.tld"
}
```

## iframe

You can embed the report into an iframe on your page.

```html theme={null}
<iframe
  src="<creditReportUrl>"
  title="<description>"
  frameborder="0"
  marginheight="0"
  marginwidth="0"
  width="100%"
  height="100%"
  scrolling="auto"
>
</iframe>
```


## OpenAPI

````yaml post /datasets/companies/{companyId}/credit-report
openapi: 3.0.4
info:
  title: TIC API
  description: ''
  version: v1
servers:
  - url: https://api.tic.io/
security:
  - ApiKey: []
tags:
  - name: BolagsverketStatistics
  - name: Companies
  - name: Companies_SE_
  - name: DocumentDelivery
  - name: EuropeanCommission
  - name: FinancialDocuments
  - name: Finansinspektionen
  - name: Free
  - name: ICA
  - name: ICAStatistics
  - name: Lists
  - name: Media
  - name: Persons
  - name: Persons_SE_
  - name: Properties_SE_
  - name: PTSPortings
  - name: Reseller
  - name: SearchBankruptciesReports
  - name: SearchCompanies
  - name: SearchCompaniesReports
  - name: SearchCompanyWorkplaces
  - name: SearchPerson
  - name: SearchProperties_SE_
  - name: SearchVehicles
  - name: TeamDocumentOrders
  - name: Teams
  - name: User
  - name: Vehicles_SE_
  - name: WatchLists
paths:
  /datasets/companies/{companyId}/credit-report:
    post:
      tags:
        - Companies
      summary: Credit Report
      description: Get a full credit report hosted on a temporary URL
      operationId: CompanyCreditReport
      parameters:
        - name: companyId
          in: path
          description: The company id
          required: true
          schema:
            type: integer
            format: int32
      requestBody:
        description: The payload
        content:
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/Ormeo_WebAPI_Models_Datasets_Company_CompanyCreditReportCreate_Dto
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Ormeo_WebAPI_Models_Datasets_Company_CompanyCreditReportCreate_Dto
          text/json:
            schema:
              $ref: >-
                #/components/schemas/Ormeo_WebAPI_Models_Datasets_Company_CompanyCreditReportCreate_Dto
          application/*+json:
            schema:
              $ref: >-
                #/components/schemas/Ormeo_WebAPI_Models_Datasets_Company_CompanyCreditReportCreate_Dto
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Ormeo_WebAPI_Models_Datasets_Company_CompanyCreditReport_Dto
components:
  schemas:
    Ormeo_WebAPI_Models_Datasets_Company_CompanyCreditReportCreate_Dto:
      required:
        - consentToPricing
      type: object
      properties:
        sendSMSToE164MobileNumber:
          type: string
          nullable: true
        sendEmailToEmailAddress:
          type: string
          format: email
          nullable: true
        consentToPricing:
          type: boolean
      additionalProperties: false
    Ormeo_WebAPI_Models_Datasets_Company_CompanyCreditReport_Dto:
      type: object
      properties:
        deliveryGuid:
          type: string
          format: uuid
        creditReportUrl:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        priceExclVat:
          type: number
          format: double
          nullable: true
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-api-key
      in: header

````