URL Expired

The URL for this request expired after 30 days.

Document Type DTO Input

Fields Definition

• uuid
  string ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

• companyUuid
  string ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

• name
  string required

• category
  string enum required

• Custom Identity

  • Documents
  • Medical & Health
  • Insurance & Compliance
  • Employment & Administrative
  • Training & Certifications
  • Vehicle & Transportation
  • Professional Licences

• description
  string required

• fields
  array of objects required

Fields Array Structure

• expirableFieldUuid
  string | null required ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

• startDateFieldUuid
  string | null ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

• forceExpirationInDays
  number | null

• forceExpirationUnits
  string enum

• days

  • months
  • years

• isAutoApprovalEnabled
  boolean required true/false

• isFraudDetectionEnabled
  boolean required true/false

• doubleSidedEnabled
  boolean true/false

• recollectionPeriodDays
  number required

• externalProcessingUrl
  string

• externalProcessingAuthHeader
  string

• instructions
  string

• enabledOcrProvider
  string | null enum

• base64

  • claude
  • openai
  • pulse
  • dibby

• ocrConfidenceThreshold
  number | null required 0 to 1

• ocrProviderConfigs
  object | null

• enabledFraudDetectionProvider
  string | null enum

• openai

• fraudDetectionProviderConfigs
  object | null

• hireMapping
  object

• autoRejectionConfig
  object

• useProxyImage
  boolean true/false

• acceptedFileTypes
  array of strings Allowed:

• pdf

  • png
  • jpg

• createdAt
  date-time

• createdBy
  string ^(00000000-0000-0000-0000-000000000000|[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})$

• updatedAt
  date-time

• updatedBy
  string ^(00000000-0000-0000-0000-000000000000|[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})$

Example

curl --request POST \
     --url https://services.fountain.com/api/servicecompliancev2/documentTypes \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\
{\
  "category": "custom",\
  "isAutoApprovalEnabled": true,\
  "isFraudDetectionEnabled": true\
}\
'```

### Responses
- **201**  
  One or many document types documents created.
- **500**  
  Default error response.

Updated 3 months ago.