v2

Investors Documentation

>>>

GET /investors/:investor_id/documentation
Documents from specific investor

Params

Param name Description
investor_id
required

Requested investor ID

Validations:

  • Must be a String

Examples

{
  'data': [
    {
      'id': 'documentation-instance-uuid',
      'filename': 'Formato-Word.docx',
      'content_type': 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
      'file_url': 'http://example-url-to-file/Formato-Word.docx',
      'notes': 'null',
      'expires': 'Thu Jul 29 2021 00:00:00 GMT-0500 (hora de verano central)',
      'created_at': '2021-07-02 20:06:04 UTC',
      'status': 'Completo',
      'documentation_id': 'documentation-uuid',
      'documentation_type': 'Investor',
      'document': {
        'id': 'document-uuid',
        'name': 'Carátula Estado de Cuenta',
        'description': 'Formato para Alta de Cuenta Bancaria',
        'extensions': [
          'pdf',
          'docx',
          'doc',
          'png',
          'jpg'
        ]
      }
    }
  ],
  'meta': {
    'count': 1
  }
}

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
>>>

GET /investors/:investor_id/documentation/:id
Specific document

Params

Param name Description
investor_id
required

Requested investor ID

Validations:

  • Must be a String
id
required

Document ID

Validations:

  • Must be a String

Examples

{
  'data': {
    'id': 'documentation-instance-uuid',
    'filename': 'Formato-Word.docx',
    'content_type': 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
    'file_url': 'http://example-url-to-file/Formato-Word.docx',
    'notes': 'null',
    'expires': 'Thu Jul 29 2021 00:00:00 GMT-0500 (hora de verano central)',
    'created_at': '2021-07-02 20:06:04 UTC',
    'status': 'Completo',
    'documentation_id': 'documentation-uuid',
    'documentation_type': 'Investor',
    'document': {
      'id': 'document-uuid',
      'name': 'Carátula Estado de Cuenta',
      'description': 'Formato para Alta de Cuenta Bancaria',
      'extensions': [
        'pdf',
        'docx',
        'doc',
        'png',
        'jpg'
      ]
    }
  }
}

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error