Artifacts

Get the artifact by the given ID and artifact type.

get/artifacts/{artifact-id}

Request

Path parameters

artifact-idstring uuid required
Example:a18952ae-a93e-48b5-b863-cf8e47156784

External ID of the contract. It matches with the flow ID.

Query parameters

artifact_type'risk-report' | 'income-report' | 'accounts' | 'transactions' | 'user-insights' required

The type of the artifact to retrieve. It must be one of the selectable artifacts, otherwise a 400 error response is returned.

Response

Artifact details

idstring UUID required

Internal artifact ID

created_atEndedAt required(unresolved $ref)
type'risk-report' | 'income-report' | 'accounts' | 'transactions' | 'user-insights' required
metaobject required

A dictionary which contains metadata of the artifact. It usually contains the user ID which triggered the flow that generated the artifact.

Changes

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the // response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 to the // response property allOf list for the response status

    • info

      removed subschema #1: Risk Report subschema #2: Income Report from the response property oneOf list for the response status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status