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
    • POSTResume an Inquiry
    • GETRetrieve an Inquiry
    • DELRedact an Inquiry
    • PATCHUpdate an Inquiry
    • GETRetrieve a Report
    • DELRedact a Report
    • GETRetrieve a Verification
    • POSTDecline an Inquiry
    • POSTApprove an Inquiry
    • GETList all Inquiries
    • POSTCreate an Inquiry
    • GETRetrieve an Account
    • DELRedact an Account
    • PATCHUpdate an Account
    • GETList all Accounts
    • POSTCreate an Account
    • GETDownload a File
    • GETList all API Logs
    • POSTCreate a Generic Document
    • GETRetrieve an API Log
    • GETRetrieve a Document
    • POSTCreate a Phone Number Verification
    • PATCHUpdate a Generic Document
    • POSTCreate a Document Verification
    • POSTSubmit a Generic Document
    • GETList all Events
    • POSTCreate a Government ID Verification
    • POSTCreate a Database Verification
    • POSTSubmit a Document Verification
    • GETRetrieve a Document Verification
    • GETRetrieve an Event
    • POSTImport Accounts
    • GETRetrieve an Importer
    • POSTConsolidate Accounts
    • POSTImport Geolocation Lists
    • POSTImport Email Address Lists
    • POSTImport Government ID Number Lists
    • POSTImport Name Lists
    • POSTImport IP Address Lists
    • POSTCreate a Government ID Document
    • POSTImport Phone Number Lists
    • PATCHUpdate a Government ID Document
    • POSTSubmit a Government ID Document
    • POSTSubmit a Government ID Verification
    • PATCHUpdate a Government ID Verification
    • GETList all Lists
    • GETRetrieve a List
    • DELArchive a List
    • POSTCreate a Browser Fingerprint List
    • POSTCreate a Geolocation List
    • POSTCreate an Email Address List
    • POSTCreate a Browser Fingerprint List Item
    • POSTCreate a Country List
    • POSTCreate an IP Address List
    • POSTCreate a Phone Number List
    • POSTCreate a Government ID Number List
    • POSTCreate a Name List
    • POSTCreate a Country List Item
    • POSTCreate an Email Address List Item
    • POSTCreate a Phone Number List Item
    • DELArchive a Browser Fingerprint List Item
    • POSTCreate an IP Address List Item
    • POSTCreate a Geolocation List Item
    • POSTCreate a Government ID Number List Item
    • DELArchive an IP Address List Item
    • DELArchive a Government ID Number List Item
    • DELArchive a Name List Item
    • DELArchive an Email Address List Item
    • DELArchive a Country List Item
    • DELArchive a Geolocation List Item
    • POSTCreate a Name List Item
    • DELArchive a Phone Number List Item
    • GETList all Reports
    • POSTCreate a Report
    • GETList all Cases
    • POSTCreate a Case
    • POSTCreate a Selfie Verification
    • POSTSubmit a Selfie Verification
    • GETRetrieve Case
    • PATCHUpdate a Case
    • POSTRemove a tag
    • POSTSet all tags
    • POSTAdd a tag
    • POSTSet all tags
    • POSTAdd a tag
    • POSTRemove a tag
    • GETPrint Inquiry PDF
    • GETPrint Verification PDF
    • GETPrint Report PDF
    • POSTReport a Government ID Verification
    • POSTBusiness Lookup Report
    • POSTAdd Persona objects
    • POSTAssign a Case
    • POSTCreate a Face List Item
    • POSTCreate a Face List
    • DELArchive a Face List Item
    • POSTImport Face Lists
    • POSTAdd a tag
    • POSTRemove a tag
    • POSTSet all tags
    • GETList all User Audit Logs
    • GETRetrieve an User Audit Log
    • POSTSet status for a case
    • GETRetrieve a Government Id Verification
    • GETRetrieve a Selfie Verification
    • POSTSubmit a Database Verification
    • GETRetrieve a Database Verification
    • POSTCreate a Phone Carrier Database Verification
    • POSTSubmit a Phone Carrier Database Verification
    • GETRetrieve a Phone Carrier Database Verification
    • POSTCreate a Serpro Database Verification
    • POSTSubmit a Serpro Database Verification
    • GETRetrieve a Serpro Database Verification
    • POSTCreate a TIN Database Verification
    • POSTSubmit a TIN Database Verification
    • GETRetrieve a TIN Database Verification
    • POSTConfirm a Phone Number Verification
    • GETRetrieve a Phone Number Verification
    • POSTSend an SMS
    • POSTCreate a Workflow Run
    • POSTCreate an Email Address Verification
    • POSTSend an email
    • POSTConfirm an Email Address Verification
    • GETRetrieve a Email Address Verification
    • GETList all API keys
    • POSTCreate an API key
    • POSTExpire an API key
    • GETRetrieve an API key
    • PATCHUpdate an API key
    • POSTAdd a tag
    • POSTRemove a tag
    • POSTSet all tags
LogoLogo
Help CenterOpenAPI SpecStatus

POST
https://withpersona.com/api/v1/document/government-ids/:document-id/submit
POST
/api/v1/document/government-ids/:document-id/submit
1curl -X POST https://withpersona.com/api/v1/document/government-ids/document-id/submit \
2 -H "Authorization: <apiKey>"
Try it
1{
2 "data": {
3 "type": "document/government-id",
4 "id": "doc_FxCzxBkkF8V1AtxmY19zhVAz",
5 "attributes": {
6 "status": "submitted",
7 "created-at": "2020-09-13T02:34:57.000Z",
8 "processed-at": {},
9 "front-photo": {},
10 "back-photo": {},
11 "selfie-photo": {},
12 "id-class": {},
13 "name-middle": {},
14 "name-last": {},
15 "birthdate": {},
16 "address-street-1": {},
17 "address-street-2": {},
18 "address-city": {},
19 "address-subdivision": {},
20 "address-postal-code": {},
21 "endorsements": {},
22 "restrictions": {},
23 "vehicle-class": {}
24 },
25 "relationships": {
26 "inquiry": {
27 "data": {
28 "type": "inquiry",
29 "id": "inq_Dj1JxEG9K153GbvFYGScCRlL"
30 }
31 }
32 }
33 }
34}
Was this page helpful?
Previous

Submit a Government ID Verification

Next
Built with
Submit a government ID document for processing. Can only submit `initiated` documents with photos of the ID attached.
Submit a Government ID Document

Authentication

Authorizationstring
API Key authentication via header

Path Parameters

document-idstringRequired

Headers

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

Response

200
dataobject or null

Errors

Submit a government ID document for processing. Can only submit initiated documents with photos of the ID attached.