Documentation Index
Fetch the complete documentation index at: https://developer.prove.com/llms.txt
Use this file to discover all available pages before exploring further.
Connect is the Prove Platform batch verification interface. Customers upload CSV files over SFTP; each valid row is verified with POST /v3/verify. Rows that pass the Global Fraud Policy are enrolled in Identity Manager. Responses match the same fields as synchronous POST /v3/verify calls.
Connect supports the verifiedUser and humanAssurance verification type.
Scope
| Item | Specification |
|---|
| Transport | SFTP to dedicated directories (ToProve / FromProve) |
| Verification | POST /v3/verify per valid detail row |
| Enrollment | Successful verifications enrolled in Identity Manager |
| Result shape | Same parameters as real-time POST /v3/verify responses |
Provisioning
The following items are provided during onboarding, and some correspond to fields in the input file. See Input file format.
| Credential | Description |
|---|
| Enroll Key | Validates file authenticity |
| Verification Type | verifiedUser or humanAssurance |
| Directory Paths | ToProve (upload) and FromProve (download) |
| SFTP Credentials | Authentication for file transfer |
Processing
Batch processing follows this sequence (see also the diagram).
| Stage | Behavior |
|---|
| Upload | CSV is placed in the provisioned ToProve directory via SFTP. |
| Validation | Each row is checked for required fields, phone format and country code, and region consistency with the file. If authorization checks fail, the entire file is rejected and an error response is written under FromProve. |
| Verification | Valid rows are sent to POST /v3/verify; response fields align with the live API. |
| Enrollment | Rows that pass the Global Fraud Policy are enrolled in Identity Manager. |
| Delivery | When processing completes, an email notification is sent; the output file is available under FromProve. |
File requirements
Input and output CSVs use the structures below. File names must follow the naming pattern.
Naming convention
{client_name}_{region}_{verification_type}_YYYYMMDDHHMMSS.csv
| Component | Values | Description |
|---|
client_name | Agreed during setup | Organization identifier |
region | US or INTL | US — US and Canada; INTL — international |
verification_type | verifiedUser or humanAssurance | Verification type |
| Column | Sample value | Required |
|---|
| Record Type | H | Yes — always H |
| Enroll Key | SecretKey | Yes |
| Verification Type | verifiedUser or humanAssurance | Yes |
| Column | Sample value | Required | Description |
|---|
| Record Type | D | Yes — always D | |
| Phone Number | +12008040444 | Yes — include country code | |
| First Name | John | Yes | |
| Last Name | Doe | Yes | |
| Client Customer ID | zaq12wsx | No | |
| Attribute Type | userId | Yes for partners | Metadata type for the attribute value. |
| Issuer ID | AcmeWallet | Yes for partners | Partner company name. |
| Attribute Value | A4B1F13BCCFC | Yes for partners | Non-PII unique value for the consumer for the given attribute type. |
| Column | Sample value | Required |
|---|
| Record Type | T | Yes — always T |
| Number of Records | 132789 | Yes |
There is no formal cap on input file size or detail record count per file. When splitting work across uploads, Prove recommends 800,000 detail records or fewer per file. Verification throughput is subject to Data Partner transactions-per-second (TPS) limits; completion time varies with detail record count and effective throughput.
H,ENROLL_KEY_US_123,verifiedUser
D,+12008040444,Sara,Hu,xsw23edc,userId,AcmeWallet,A4B1F13BCCFC
D,+12005551234,John,Doe,abc12345,,,
T,2
FromProve. It mirrors the input layout and appends verification fields (for example assurance level, identity attributes, status).
| Column | Sample value | Notes |
|---|
| Record Type | H | Always H |
Detail records (output)
| Column | Sample value | Notes |
|---|
| Record Type | D | Always D |
| Phone Number | +12008040444 | |
| First Name | John | |
| Last Name | Doe | |
| Client Customer ID | zaq12wsx | If present on input |
| Attribute Type | userId | |
| Issuer ID | AcmeWallet | |
| Attribute Value | A4B1F13BCCFC | |
| Assurance Level | AL2 | If successful |
| Assurance Level Reason Codes | AL2a, AL2b | If successful |
| Prove Phone Alias | 474628DC4VK83842DB25DA4B1F13BCCFC0MEK4P664Z9PCC6E6C3CB92DC40191E5E868E5E38B1AC85F6G359B74880097B63C51E7E8636B33FA344CB8E | If successful |
| ProveID | 6b942541-abab-40ed-9970-5a28217836c0 | If successful |
| Error | 200 | |
| Error Message | NA | |
| GFP Authentication Result | pass | If successful |
| GFP Risk Result | pass | If successful |
Only the top-level identity is included in the output; additional identities are omitted.
Trailer record (output)
| Column | Sample value | Notes |
|---|
| Record Type | T | Always T |
| Number of Records | 132789 | |
FromProve, with machine-readable codes.
| Error Code | Description |
|---|
ERR_MISSING_FNAME | First name is missing |
ERR_MISSING_LNAME | Last name is missing |
ERR_MISSING_PHONE | Phone number is missing |
ERR_FORMAT_PHONE | Invalid phone number format |
ERR_PHONE_COUNTRY_NOTSUPPORTED | Phone country not supported |
ERR_DUPLICATE_RECORD_ORIGINAL_PRESERVED | Duplicate record detected |
US phone numbers must not appear in international-region files, and international numbers must not appear in US-region files; mismatches produce row errors.
| Column | Sample value | Notes |
|---|
| Record Type | H | Always H |
| Verification Type | verifiedUser or humanAssurance | |
Detail records (error file)
| Column | Sample value | Notes |
|---|
| Record Type | D | Always D |
| Phone Number | +12008040444 | |
| First Name | John | |
| Last Name | Doe | |
| Client Customer ID | zaq12wsx | If present on input |
| Error Attribution | ERR_MISSING_FNAME | |
Trailer record (error file)
| Column | Sample value | Notes |
|---|
| Record Type | T | Always T |
| Number of Records | 132789 | |
Notifications
Email alerts
| Event | Email sent | Body |
|---|
| File rejected | Yes, when configured | Rejection details per onboarding configuration. |
| File processed successfully | Yes, when configured | Includes data quality statistics.. |
