Skip to content

Onboarding Justifications

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/onboarding-justifications/ List Onboarding Justifications
GET /api/onboarding-justifications/{uuid}/ Retrieve
POST /api/onboarding-justifications/ Create
POST /api/onboarding-justifications/create_justification/ Create justification for failed verification
PUT /api/onboarding-justifications/{uuid}/ Update
PATCH /api/onboarding-justifications/{uuid}/ Partial Update
DELETE /api/onboarding-justifications/{uuid}/ Delete
Other Actions
POST /api/onboarding-justifications/{uuid}/approve/ Approve justification and mark verification as VERIFIED
POST /api/onboarding-justifications/{uuid}/attach_document/ Attach supporting document to justification
POST /api/onboarding-justifications/{uuid}/reject/ Reject justification and mark verification as FAILED

Core CRUD

List Onboarding Justifications

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-justifications/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_justifications_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: onboarding_justifications_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { onboardingJustificationsList } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
created string (date-time)
modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_justifications_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_justifications_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsRetrieve } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
created string (date-time)
modified string (date-time)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/onboarding-justifications/ \
  Authorization:"Token YOUR_API_TOKEN" \
  verification="https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_request import OnboardingJustificationRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationRequest(
    verification="https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = onboarding_justifications_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationRequest
  2. API Source: onboarding_justifications_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsCreate } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "verification": "https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
verification string (uri) ✓
user_justification string User's explanation for why they should be authorized

201 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
created string (date-time)
modified string (date-time)

Create justification for failed verification

Create justification for failed verification.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/onboarding-justifications/create_justification/ \
  Authorization:"Token YOUR_API_TOKEN" \
  verification_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_create_request import OnboardingJustificationCreateRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_create_justification # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationCreateRequest(
    verification_uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = onboarding_justifications_create_justification.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationCreateRequest
  2. API Source: onboarding_justifications_create_justification
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsCreateJustification } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsCreateJustification({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "verification_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
verification_uuid string (uuid) ✓ UUID of the OnboardingVerification to justify
user_justification string User's explanation for why they should be authorized

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
created string (date-time)
modified string (date-time)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  verification="https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_request import OnboardingJustificationRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationRequest(
    verification="https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = onboarding_justifications_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationRequest
  2. API Source: onboarding_justifications_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { onboardingJustificationsUpdate } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "verification": "https://api.example.com/api/verification/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
verification string (uri) ✓
user_justification string User's explanation for why they should be authorized

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
created string (date-time)
modified string (date-time)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_onboarding_justification_request import PatchedOnboardingJustificationRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOnboardingJustificationRequest()
response = onboarding_justifications_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOnboardingJustificationRequest
  2. API Source: onboarding_justifications_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsPartialUpdate } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
verification string (uri)
user_justification string User's explanation for why they should be authorized

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
created string (date-time)
modified string (date-time)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = onboarding_justifications_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: onboarding_justifications_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsDestroy } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

Approve justification and mark verification as VERIFIED

Approve justification and mark verification as VERIFIED.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/approve/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_review_request import OnboardingJustificationReviewRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_approve # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationReviewRequest()
response = onboarding_justifications_approve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationReviewRequest
  2. API Source: onboarding_justifications_approve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsApprove } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsApprove({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
staff_notes string Administrator notes about the review decision

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
created string (date-time)
modified string (date-time)

Attach supporting document to justification

Attach supporting document to justification.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/attach_document/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_documentation_request import OnboardingJustificationDocumentationRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_attach_document # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationDocumentationRequest()
response = onboarding_justifications_attach_document.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationDocumentationRequest
  2. API Source: onboarding_justifications_attach_document
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsAttachDocument } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsAttachDocument({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
file string (binary) Upload supporting documentation.

200 -

Field Type Description
uuid string (uuid)
file string (uri) Upload supporting documentation.
file_name string
file_size integer
created string (date-time)

Reject justification and mark verification as FAILED

Reject justification and mark verification as FAILED.

1
2
3
4
http \
  POST \
  https://api.example.com/api/onboarding-justifications/a1b2c3d4-e5f6-7890-abcd-ef1234567890/reject/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.onboarding_justification_review_request import OnboardingJustificationReviewRequest # (1)
from waldur_api_client.api.onboarding_justifications import onboarding_justifications_reject # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OnboardingJustificationReviewRequest()
response = onboarding_justifications_reject.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OnboardingJustificationReviewRequest
  2. API Source: onboarding_justifications_reject
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { onboardingJustificationsReject } from 'waldur-js-client';

try {
  const response = await onboardingJustificationsReject({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
staff_notes string Administrator notes about the review decision

200 -

Field Type Description
uuid string (uuid)
verification string (uri)
verification_uuid string (uuid)
country string
user string (uri)
legal_person_identifier string
legal_name string
error_message string
error_traceback string
user_justification string User's explanation for why they should be authorized
validated_by string (uri)
validated_at string (date-time)
validation_decision any
staff_notes string Administrator notes on the review decision
supporting_documentation array of objects
supporting_documentation.uuid string (uuid)
supporting_documentation.file string (uri) Upload supporting documentation.
supporting_documentation.file_name string
supporting_documentation.file_size integer
supporting_documentation.created string (date-time)
created string (date-time)
modified string (date-time)