Get declaration processing status
Check the processing status of a submitted declaration. Use the cidV1 identifier returned from the /v1/declare endpoint.
Status values:
pending- Declaration is queued and being processedsuccess- Declaration was successfully processed and indexedfailed- Declaration processing failed (see message for details)
Recommended polling strategy:
- Submit declaration via
/v1/declare - Use returned
cidV1to poll this endpoint - Poll every 2-5 seconds until status is
successorfailed - If
success, declaration is available via search and metadata APIs
path Parameters
identifierstring · requiredCIDv1 identifier of the declaration (returned as
cidV1from the declare endpoint)
Headers
Authorizationstring · requiredBearer token for authentication (e.g.,
Bearer <your-api-key>)
Responses
Successful operation - Status retrieved
identifierstring · requiredThe CIDv1 identifier of the declaration
statusstring · enum · requiredCurrent processing status of the declaration:
pending: Declaration is in the processing queuesuccess: Declaration was successfully processed and is now searchablefailed: Processing failed - see message for error details
Enum values:pendingsuccessfailedversionstring · requiredAPI version
messagestringAdditional information about the status. Contains error details when status is 'failed'.
createdAtinteger · int64Unix timestamp (milliseconds) when the status record was created (i.e., when declaration was submitted)
createdAtDateTimestringHuman-readable date/time when the status record was created
updatedAtinteger · int64Unix timestamp (milliseconds) when the status was last updated
updatedAtDateTimestringHuman-readable date/time when the status was last updated