Help CenterOpenAPI SpecStatus
DocumentationAPI ReferenceChangelogIntegration Guides
DocumentationAPI ReferenceChangelogIntegration Guides
  • Getting Started
    • Introduction
    • Quickstart Tutorial
  • API Overview
    • API Keys
    • Authentication
    • Protocol
    • Idempotence
    • Pagination
    • Serialization
    • Rate Limiting
    • Downloading Files
    • API Logs
    • Request IDs
  • Versioning
    • API Changelog
    • Versioning
  • Troubleshooting
    • Error Handling
  • API Reference
    • GETRetrieve an Inquiry
    • DELRedact an Inquiry
    • PATCHUpdate an Inquiry
    • POSTResume an Inquiry
    • GETRetrieve a Verification
    • POSTApprove an Inquiry
    • GETRetrieve a Report
    • GETRetrieve an Account
    • DELRedact an Account
    • PATCHUpdate an Account
    • POSTDecline an Inquiry
    • GETList all Accounts
    • POSTCreate an Account
    • GETList all Inquiries
    • POSTCreate an Inquiry
    • GETDownload a File
    • GETList all API Logs
    • GETRetrieve an API Log
    • POSTCreate a Generic Document
    • POSTSubmit a Generic Document
    • POSTCreate a Phone Number Verification
    • GETList all Events
    • PATCHUpdate a Generic Document
    • GETRetrieve a Document
    • POSTCreate a Database Verification
    • POSTCreate a Government ID Verification
    • POSTCreate a Document Verification
    • GETRetrieve an Event
    • POSTSubmit a Document Verification
    • GETRetrieve a Document Verification
    • POSTImport Accounts
    • POSTConsolidate Accounts
    • GETRetrieve an Importer
    • POSTImport Government ID Number Lists
    • POSTImport Geolocation Lists
    • POSTImport Email Address Lists
    • POSTImport IP Address Lists
    • POSTImport Name Lists
    • POSTImport Phone Number Lists
    • POSTCreate a Government ID Document
    • POSTSubmit a Government ID Verification
    • POSTSubmit a Government ID Document
    • PATCHUpdate a Government ID Document
    • GETRetrieve a List
    • DELArchive a List
    • GETList all Lists
    • POSTCreate a Browser Fingerprint List
    • PATCHUpdate a Government ID Verification
    • POSTCreate a Country List
    • POSTCreate an Email Address List
    • POSTCreate a Geolocation List
    • POSTCreate a Government ID Number List
    • POSTCreate an IP Address List
    • POSTCreate a Name List
    • POSTCreate a Browser Fingerprint List Item
    • POSTCreate a County List Item
    • POSTCreate a Phone Number List
    • POSTCreate an Email Address List Item
    • POSTCreate an IP Address List Item
    • POSTCreate a Name List Item
    • POSTCreate a Phone Number List Item
    • POSTCreate a Government ID Number List Item
    • POSTCreate a Geolocation List Item
    • DELArchive a Browser Fingerprint List Item
    • DELArchive a Country List Item
    • DELArchive an Email Address List Item
    • DELArchive a Geolocation List Item
    • DELArchive a Name List Item
    • DELArchive a Phone Number List Item
    • DELArchive a Government ID Number List Item
    • DELArchive an IP Address List Item
    • GETList all Reports
    • POSTCreate a Report
    • GETRetrieve Case
    • GETList all Cases
    • POSTAdd a tag
    • POSTSubmit a Selfie Verification
    • POSTRemove a tag
    • POSTSet all tags
    • POSTRemove a tag
    • POSTCreate a Selfie Verification
    • POSTAdd a tag
    • POSTSet all tags
LogoLogo
Help CenterOpenAPI SpecStatus

Submit a Document Verification

POST
https://withpersona.com/api/v1/verification/documents/:verification-id/submit
POST
/api/v1/verification/documents/:verification-id/submit
1curl -X POST https://withpersona.com/api/v1/verification/documents/verification-id/submit \
2     -H "Authorization: <apiKey>"
Try it
1{
2  "data": {
3    "type": "verification/document",
4    "id": "ver_ppsBhYEdqZnHKVXag9QMDvMu",
5    "attributes": {
6      "status": "submitted",
7      "created-at": "2020-06-25T01:04:39.000Z",
8      "created-at-ts": 1593047079,
9      "submitted-at": "2020-06-25T01:12:10.000Z",
10      "submitted-at-ts": 1593047530,
11      "completed-at": {},
12      "completed-at-ts": {},
13      "country-code": {}
14    },
15    "relationships": {
16      "inquiry": {
17        "data": {
18          "type": "inquiry",
19          "id": "inq_TnxzsSeQa6qqNY6zLPvQmFmg"
20        }
21      },
22      "document": {
23        "data": {
24          "type": "document/generic",
25          "id": "doc_BDxMaFYynbVrKPiGdfv4aJyC"
26        }
27      }
28    }
29  }
30}
Submit a document verification for processing. Can only submit `initiated` verifications.
Was this page helpful?
Previous

Retrieve a Document Verification

Next
Build with
Retrieve a Document Verification

Submit a document verification for processing. Can only submit initiated verifications.

Authentication

Authorizationstring
API Key authentication via header

Path Parameters

verification-idstringRequired

Headers

Key-InflectionstringOptional
Determines casing for the API response
Idempotency-KeystringOptional
Ensures the request is idempotent

Response

200
dataobject or null

Errors