Types, templates, and signers
Resolve documentTypeId, templateId, and signer NPI before you create a signature task.
Call these read endpoints with the same x-api-key you will use on Create Task. They are scoped to the organization on that key.
Document types
GET /api/v1/documenttypes
Use the returned id as document.documentTypeId.
[
{
"id": 1008,
"name": "Order",
"category": "Clinical"
}
]Templates
GET /api/v1/signature/templates
Templates are created in the SutureHealth UI for your organization. Use templateId on document.annotations when annotations.type is Template (and you may still send it for the other placement types).
[
{
"templateId": 503820,
"summary": "Home health certification",
"clinicalDateLabel": "Effective Date",
"diagnosisCodeAllowed": true,
"diagnosisCodeRequired": true,
"pdfRequired": true,
"isCustomTemplate": true
}
]If diagnosisCodeRequired is true, Create Task returns 400 unless you send document.diagnosisCode.
Signer by NPI
GET /api/v1/users/providers/{npi}
npi must be exactly 10 digits.
{
"npi": "1234567890",
"firstName": "Alex",
"lastName": "Rivera",
"signingName": "Alex Rivera, MD",
"organizations": [
{
"name": "Springfield Family Medicine",
"npi": "9876543210",
"addresses": [
{
"line": "123 Main Street",
"city": "Springfield",
"state": "IL",
"postalCode": "62704"
}
]
}
]
}| Result | Meaning |
|---|---|
200 | Active provider. You can send that NPI as performers[].signer.userNPI. The response includes the provider’s active organizations. Use those NPIs and addresses when routing. |
400 | NPI is not 10 digits. Create Task would also reject this. |
404 | No active user with that NPI. Create Task may still return 201, but the task later moves to Failed during signer match. |
Updated 5 days ago
Did this page help you?
