curl --request POST \
--url https://api2.rhombussystems.com/api/upload/guestManagement/document \
--header 'Content-Type: multipart/form-data' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--form 'bodyParts={
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"parent": {
"bodyParts": "<array>",
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"providers": {}
},
"providers": {}
}' \
--form 'contentDisposition={
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
}' \
--form 'entity={}' \
--form 'fields={}' \
--form 'headers={
"empty": true
}' \
--form 'mediaType={
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
}' \
--form 'messageBodyWorkers={}' \
--form 'parameterizedHeaders={
"empty": true
}' \
--form 'parent={
"bodyParts": "<array>",
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"providers": {}
}' \
--form 'providers={}'{
"allowedMethods": [
"<string>"
],
"closed": true,
"cookies": {},
"date": "2023-11-07T05:31:56Z",
"entity": {},
"entityTag": {
"value": "<string>",
"weak": true
},
"headers": {
"empty": true
},
"language": {
"country": "<string>",
"displayCountry": "<string>",
"displayLanguage": "<string>",
"displayName": "<string>",
"displayScript": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Country": "<string>",
"iso3Language": "<string>",
"language": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"variant": "<string>"
},
"lastModified": "2023-11-07T05:31:56Z",
"length": 123,
"links": [
{
"params": {},
"rel": "<string>",
"rels": [
"<string>"
],
"title": "<string>",
"type": "<string>",
"uri": "<string>",
"uriBuilder": {}
}
],
"location": "<string>",
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"metadata": {
"empty": true
},
"status": 123,
"statusInfo": {
"reasonPhrase": "<string>",
"statusCode": 123
},
"stringHeaders": {
"empty": true
}
}Upload guest management document
Uploads a PDF or DOCX document for guest management (e.g. for e-signature via SignatureAPI), storing it in S3 and recording it on the org’s guest management settings.
curl --request POST \
--url https://api2.rhombussystems.com/api/upload/guestManagement/document \
--header 'Content-Type: multipart/form-data' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--form 'bodyParts={
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"parent": {
"bodyParts": "<array>",
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"providers": {}
},
"providers": {}
}' \
--form 'contentDisposition={
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
}' \
--form 'entity={}' \
--form 'fields={}' \
--form 'headers={
"empty": true
}' \
--form 'mediaType={
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
}' \
--form 'messageBodyWorkers={}' \
--form 'parameterizedHeaders={
"empty": true
}' \
--form 'parent={
"bodyParts": "<array>",
"contentDisposition": {
"attachment": true,
"charset": {
"registered": true
},
"creationDate": "2023-11-07T05:31:56Z",
"filename": "<string>",
"formData": true,
"inline": true,
"modificationDate": "2023-11-07T05:31:56Z",
"name": "<string>",
"readDate": "2023-11-07T05:31:56Z",
"size": 123,
"type": "<string>"
},
"entity": {},
"headers": {
"empty": true
},
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"messageBodyWorkers": {},
"parameterizedHeaders": {
"empty": true
},
"providers": {}
}' \
--form 'providers={}'{
"allowedMethods": [
"<string>"
],
"closed": true,
"cookies": {},
"date": "2023-11-07T05:31:56Z",
"entity": {},
"entityTag": {
"value": "<string>",
"weak": true
},
"headers": {
"empty": true
},
"language": {
"country": "<string>",
"displayCountry": "<string>",
"displayLanguage": "<string>",
"displayName": "<string>",
"displayScript": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Country": "<string>",
"iso3Language": "<string>",
"language": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"variant": "<string>"
},
"lastModified": "2023-11-07T05:31:56Z",
"length": 123,
"links": [
{
"params": {},
"rel": "<string>",
"rels": [
"<string>"
],
"title": "<string>",
"type": "<string>",
"uri": "<string>",
"uriBuilder": {}
}
],
"location": "<string>",
"mediaType": {
"charset": {
"registered": true
},
"concrete": true,
"parameters": {},
"qualityValue": 123,
"subtype": "<string>",
"subtypeSuffix": "<string>",
"type": "<string>",
"wildcardSubtype": true,
"wildcardType": true
},
"metadata": {
"empty": true
},
"status": 123,
"statusInfo": {
"reasonPhrase": "<string>",
"statusCode": 123
},
"stringHeaders": {
"empty": true
}
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
api-token, api, partner-api-token, partner-api Body
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?