Create Applicant Files: ResMan

POST

/v1/applicants/resman/:applicant_id/file-upload

POST

/v1/applicants/resman/:applicant_id/file-upload

curl -X POST https://api.propexo.com/v1/applicants/resman/applicant_id/file-upload \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "resman-7890",
  "application_id": "app-456123",
  "attachments": [
    {
      "file_data": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQgY29udGVudA==",
      "file_name": "lease_agreement.pdf",
      "mime_type": "application/pdf"
    }
  ]
}'

{
  "meta": {
    "job_id": "job-20240615-123456"
  },
  "result": {
    "integration_id": "resman-7890",
    "applicant_id": "applicant-12345",
    "application_id": "app-456123",
    "attachments": [
      {
        "file_name": "lease_agreement.pdf",
        "mime_type": "application/pdf",
        "file_data": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQgY29udGVudA=="
      }
    ]
  }
}

Create Applicant Files: ResMan

Interface	Method
Documents	/Documents/Attach

Notice

Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

applicant_idstringRequired

The Propexo unique identifier for the applicant

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

application_idstringRequired

The Propexo unique identifier for the application

attachmentslist of objectsRequired

The files to be uploaded to the application. All the files can have a maximum combined file size of 50 MB

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error