e-Próspera
Reference

Upload proof of address

View as Markdown
POST
/api/v1/uploads/proof_of_address

Authorization

partnerKey
AuthorizationBearer <token>

Partner Key for one approved Partner Integration. Keys are lifecycle- and scope-checked, and cross-integration resources are hidden.

In: header

Header Parameters

Idempotency-Key?string

Makes retried partner write requests safe.

Length1 <= length

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/uploads/proof_of_address" \  -F applicationId="97ab27fa-30e2-43e3-92a3-160e80f4c0d5" \  -F file="string"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",    "contentType": "string",    "size": 0  }}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}