CertifID

CertifID Integration API

The Integration API from CertifID — 12 operation(s) for integration.

GitHub OpenAPI

Operations 12

GET /api/v1/Integration/Collect/{requestId}/Certificate Get the confirmation PDF certificate associated with a successfully completed collect request.
GET /api/v1/Integration/Collect/{requestId} Retrieve the latest state of an initiated request within CertifID's platform.
GET /api/v1/Integration/Send/{requestId}/Certificate Get the confirmation PDF certificate associated with a successfully completed send request.
GET /api/v1/Integration/Send/{requestId} Retrieve the latest state of an initiated send request within CertifID's platform.
GET /api/v1/Integration/Confirm/{requestId}/Certificate Get the confirmation PDF certificate associated with a successfully completed collect request.
GET /api/v1/Integration/Confirm/{requestId} Retrieve the latest state of an initiated confirm request within CertifID's platform.
GET /api/v1/Integration/Identity/{requestId}/Certificate Get the confirmation PDF certificate associated with a successfully completed identity request.
GET /api/v1/Integration/Disbursement/{disbursementId}/Certificate Get the confirmation PDF certificate associated with a successfully validated disbursement.
GET /api/v1/Integration/Disbursement/{id} Gets a Disbursement (Payoff) by ID
GET /api/v1/Integration/PayoffOrder/{id} Gets a payoff order by its ID.
GET /api/v1/Integration/PayoffOrder/{payoffOrderId}/Quote/{quoteId}/Certificate Get the quote PDF associated with payoff order.
GET /api/v1/Integration/Identity/{requestId} Retrieves the latest state of an initiated IDV request.

Documentation

📖
APIReference
https://api.certifid.com/swagger/index.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/authentication/certifid-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/openapi/certifid-integration-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/scopes/certifid-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/errors/certifid-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/conventions/certifid-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/data-model/certifid-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/certifid-integration-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

certifid-integration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Certifid Integration API
  version: v1
  description: 'Operations tagged Integration across 2 of this provider''s published API definitions: certifid-integration-api-openapi.yml, certifid-v2-apis-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.certifid.com
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- oauth2: []
tags:
- name: Integration
paths:
  /api/v1/Integration/Collect/{requestId}/Certificate:
    get:
      tags:
      - Integration
      summary: Get the confirmation PDF certificate associated with a successfully completed collect request.
      parameters:
      - name: requestId
        in: path
        description: The ID of the completed request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:requests|requestId|CollectRequest
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/Collect/{requestId}:
    get:
      tags:
      - Integration
      summary: Retrieve the latest state of an initiated request within CertifID's platform.
      parameters:
      - name: requestId
        in: path
        description: The ID of the request, assigned by CertifID's platform upon initiation.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:requests|requestId|CollectRequest
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/Send/{requestId}/Certificate:
    get:
      tags:
      - Integration
      summary: Get the confirmation PDF certificate associated with a successfully completed send request.
      parameters:
      - name: requestId
        in: path
        description: The ID of the completed request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:requests|requestId|SendRequest
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/Send/{requestId}:
    get:
      tags:
      - Integration
      summary: Retrieve the latest state of an initiated send request within CertifID's platform.
      parameters:
      - name: requestId
        in: path
        description: The ID of the request, assigned by CertifID's platform upon initiation.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:requests|requestId|SendRequest
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/Confirm/{requestId}/Certificate:
    get:
      tags:
      - Integration
      summary: Get the confirmation PDF certificate associated with a successfully completed collect request.
      parameters:
      - name: requestId
        in: path
        description: The ID of the completed request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:requests|requestId|ConfirmRequest
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/Confirm/{requestId}:
    get:
      tags:
      - Integration
      summary: Retrieve the latest state of an initiated confirm request within CertifID's platform.
      parameters:
      - name: requestId
        in: path
        description: The ID of the request, assigned by CertifID's platform upon initiation.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:requests|requestId|ConfirmRequest
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/Identity/{requestId}/Certificate:
    get:
      tags:
      - Integration
      summary: Get the confirmation PDF certificate associated with a successfully completed identity request.
      parameters:
      - name: requestId
        in: path
        description: The ID of the completed request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:requests|requestId|IdentityRequest
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/Disbursement/{disbursementId}/Certificate:
    get:
      tags:
      - Integration
      summary: Get the confirmation PDF certificate associated with a successfully validated disbursement.
      parameters:
      - name: disbursementId
        in: path
        description: The ID of the disbursement
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:requests|disbursementId|DisbursementVerification
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/Disbursement/{id}:
    get:
      tags:
      - Integration
      summary: Gets a Disbursement (Payoff) by ID
      parameters:
      - name: id
        in: path
        description: Disbursement (Payoff) ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns Payoff
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel'
        '400':
          description: Returns Bad Request details
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation'
            application/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation'
            text/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation'
        '404':
          description: Returns that the Disbursement (Payoff) ID provided was not found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Returns Unauthorized
        '403':
          description: Returns Forbidden (consumer does not have access to this Disbursement (Payoff))
      security:
      - oauth2:
        - ResourceAccessToken|read:disbursements|id|DisbursementVerification
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/PayoffOrder/{id}:
    get:
      tags:
      - Integration
      summary: Gets a payoff order by its ID.
      parameters:
      - name: payoffOrderId
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder'
            application/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder'
            text/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '500':
          description: Internal Server Error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:payofforder|payoffOrderId|PayoffOrder
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/PayoffOrder/{payoffOrderId}/Quote/{quoteId}/Certificate:
    get:
      tags:
      - Integration
      summary: Get the quote PDF associated with payoff order.
      parameters:
      - name: payoffOrderId
        in: path
        description: The id of the payoff order.
        required: true
        schema:
          type: string
      - name: quoteId
        in: path
        description: The id of the payoff order quote desired.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:payofforder|payoffOrderId|PayoffOrder
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
  /api/v1/Integration/Identity/{requestId}:
    get:
      tags:
      - Integration
      summary: Retrieves the latest state of an initiated IDV request.
      parameters:
      - name: requestId
        in: path
        description: The ID of the submitted IDV request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - oauth2:
        - ResourceAccessToken|read:requests|requestId|IdentityRequest
    servers:
    - url: https://api.certifid.com
      description: Base URL declared by the provider in apis.yml (roadmap#122).
components:
  schemas:
    CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.Party:
      required:
      - firstName
      - lastName
      type: object
      properties:
        firstName:
          minLength: 1
          pattern: ^[A-Za-z]{1}[A-Za-z-'\. ]{0,49}$
          type: string
          description: The party's first name.
          example: Alex
        lastName:
          minLength: 1
          pattern: ^[A-Za-z]{1}[A-Za-z-'\. ]{0,49}$
          type: string
          description: The party's last name.
          example: Smith
        email:
          maxLength: 100
          type:
          - string
          - 'null'
          description: The party's email address.
          format: email
          example: asmith@email.com
        phone:
          pattern: ^[0-9]{10}$
          type:
          - string
          - 'null'
          description: The party's phone number.
          example: '5038675309'
        role:
          $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PublicRecipientType'
        roleOther:
          type:
          - string
          - 'null'
          description: 'If "Other" is selected for the party, allows the integrating system to send a value

            other than the preset list.'
        customEmailMessage:
          maxLength: 550
          minLength: 0
          type:
          - string
          - 'null'
          description: Custom text section will be part of the recipient's invite message, in the email's body.
          example: "\n            This is a demo message from the title agent to the buyer, which will be added to the invite email.\n            "
      additionalProperties: false
      description: A party to a file/deal.
    System.Net.HttpStatusCode:
      enum:
      - Continue
      - SwitchingProtocols
      - Processing
      - EarlyHints
      - OK
      - Created
      - Accepted
      - NonAuthoritativeInformation
      - NoContent
      - ResetContent
      - PartialContent
      - MultiStatus
      - AlreadyReported
      - IMUsed
      - MultipleChoices
      - MovedPermanently
      - Found
      - SeeOther
      - NotModified
      - UseProxy
      - Unused
      - TemporaryRedirect
      - PermanentRedirect
      - BadRequest
      - Unauthorized
      - PaymentRequired
      - Forbidden
      - NotFound
      - MethodNotAllowed
      - NotAcceptable
      - ProxyAuthenticationRequired
      - RequestTimeout
      - Conflict
      - Gone
      - LengthRequired
      - PreconditionFailed
      - RequestEntityTooLarge
      - RequestUriTooLong
      - UnsupportedMediaType
      - RequestedRangeNotSatisfiable
      - ExpectationFailed
      - MisdirectedRequest
      - UnprocessableEntity
      - Locked
      - FailedDependency
      - UpgradeRequired
      - PreconditionRequired
      - TooManyRequests
      - RequestHeaderFieldsTooLarge
      - UnavailableForLegalReasons
      - InternalServerError
      - NotImplemented
      - BadGateway
      - ServiceUnavailable
      - GatewayTimeout
      - HttpVersionNotSupported
      - VariantAlsoNegotiates
      - InsufficientStorage
      - LoopDetected
      - NotExtended
      - NetworkAuthenticationRequired
      type: string
    CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PublicRequestStatus:
      enum:
      - CertifId
      - Expired
      - Failed
      - Started
      - Sent
      - Rejected
      - Canceled
      - HighRisk
      type: string
      description: The various statuses of a wiring instructions related request in the CertifID platform.
    CertifID.V2.PayoffOrdering.Common.Models.PayoffOrderLenderInfo:
      type: object
      properties:
        lenderId:
          type:
          - string
          - 'null'
        lenderName:
          type:
          - string
          - 'null'
      additionalProperties: false
    CertifID.V2.PayoffOrdering.Common.Models.IntegrationData:
      type: object
      properties:
        fileId:
          type: string
        type:
          type: string
        fileNumber:
          type: string
        integrationId:
          type: string
      additionalProperties: false
    CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        created:
          type:
          - string
          - 'null'
          format: date-time
        createdBy:
          type:
          - string
          - 'null'
        modified:
          type:
          - string
          - 'null'
          format: date-time
        modifiedBy:
          type:
          - string
          - 'null'
        companyId:
          type: string
        locationId:
          type:
          - string
          - 'null'
        userId:
          type: string
        status:
          $ref: '#/components/schemas/CertifID.V2.PayoffOrdering.Common.Enums.PayoffOrderStatus'
        integrationData:
          $ref: '#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.IntegrationData'
        createdAt:
          type: string
        accountType:
          $ref: '#/components/schemas/CertifID.V2.PayoffOrdering.Common.Enums.PayoffAccountType'
        fileNumber:
          type: string
        loanNumber:
          type: string
        lender:
          $ref: '#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrderLenderInfo'
        borrowerFirstName:
          type: string
        borrowerLastName:
          type: string
        secondaryBorrowerFirstName:
          type:
          - string
          - 'null'
        secondaryBorrowerLastName:
          type:
          - string
          - 'null'
        fullPropertyAddress:
          type: string
        goodThroughDate:
          type: string
        specialInstructions:
          type:
          - string
          - 'null'
        parentOrderId:
          type:
          - string
          - 'null'
        childOrderId:
          type:
          - string
          - 'null'
        borrowerAuthorizationUrl:
          type:
          - string
          - 'null'
        orderAttachmentUrls:
          type:
          - array
          - 'null'
          items:
            type: string
        payoffQuotes:
          type: array
          items:
            $ref: '#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffQuote'
        payoffOrderEvents:
          type: array
          items:
            $ref: '#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrderEvent'
        unstructuredOrderData:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
      additionalProperties: false
    CertifID.V2.Common.Models.Integrations.IntegrationData:
      type: object
      properties:
        externalPartyId:
          type:
          - string
          - 'null'
        fileId:
          type:
          - string
          - 'null'
        sourceTPS:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/CertifID.V2.Common.Models.Integrations.IntegrationProviderType'
      additionalProperties: false
    CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.VerificationDetails:
      type: object
      properties:
        displayName:
          type: string
          description: Display name of the status of the request
        uniqueLink:
          type:
          - string
          - 'null'
          description: Unique link if share_link was chosen as delivery method
        descriptionTitle:
          type: string
          description: Description title of the status of the verification request
        descriptionLong:
          type: string
          description: Verbose description of the status of the verification request
        descriptionShort:
          type: string
          description: Concise description of the status of the verification request
      additionalProperties: false
    CertifID.V2.PublicAPIsService.Common.Models.PublicModels.PayoffStatus:
      enum:
      - UnableToValidate
      - HighRisk
      - CertifID
      - Pending
      - Canceled
      - NeedsAttention
      type: string
    CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PropertyAddress:
      type: object
      properties:
        streetAddress:
          type:
          - string
          - 'null'
          description: The street address of the property being described.
          example: 123 Some Way
        streetAddress2:
          type:
          - string
          - 'null'
          description: The second line of the street address.
          example: Unit 12
        city:
          type:
          - string
          - 'null'
          description: The city of the property being described.
          example: Georgetown
        state:
          type:
          - string
          - 'null'
          description: The state of the property being described.
          example: OR
        zip:
          type:
          - string
          - 'null'
          description: The ZIP code of the property being described.
          example: '78642'
      additionalProperties: false
      description: A description of the property in question.
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    ? CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest_1_CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel
    : required:
      - recipient
      type: object
      properties:
        accountId:
          type:
          - string
          - 'null'
          description: 'The unique identifier for the account/location within the customer''s organization in CertifID''s platform from which the

            request is being sent.

            If not specified, the customer''s default or current account will be selected initially.'
          example: 00000000-0000-0000-0000-000000000001
        fileNumber:
          maxLength: 254
          type:
          - string
          - 'null'
          description: 'A file number identifying a deal/file in the 3rd party system, such as a mortgage

            origination system.'
          example: A4242
        transactionId:
          maxLength: 254
          type:
          - string
          - 'null'
          description: A given transaction id for a CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1.FileNumber from the 3rd party origination system.
          example: '20336491'
        recipient:
          $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.Party'
        requestDetails:
          $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel'
        id:
          type: string
          description: A unique identifier for this request, provided by the CertifID platform.
      additionalProperties: false
    CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.RejectFeedback:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.RejectFeedbackType'
        typeDisplayText:
          type: string
        freeText:
          type: string
      additionalProperties: false
    CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.BorrowerResponseModel:
      type: object
      properties:
        entityName:
          type: string
          description: Entity Name
        firstName:
          type: string
          description: First Name
        lastName:
          type: string
          description: Last Name
        type:
          $ref: '#/components/schemas/CertifID.MortgagePayoff.Common.Models.Borrowers.BorrowerType'
      additionalProperties: false
      description: Payoff Protect Borrower
    CertifID.V2.PayoffOrdering.Common.Enums.PayoffOrderStatus:
      enum:
      - Pending
      - InProgress
      - SubmittedToLender
      - Delivered
      - Canceled
      - Unorderable
      type: string
    CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PublicIdentityRequestStatus'
        verificationDetails:
          $ref: '#/co

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/certifid/refs/heads/main/openapi/certifid-integration-api-openapi.yml