SWAP PROFILE API 20250721.1255+365079f
API for the Profile service of SWAP project
Company
POST
/api/v1/company-profile/
Create new company
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"title" : "string" ,
"tax_identification_number" : "string" ,
"address" : "string" ,
"logo_image" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"description" : "string" ,
"activity_scopes" : [
"string"
],
"documents" : [
"1a877295-da17-423c-a7fa-0dde8eb8cf06"
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"tax_identification_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"address" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Corporate Address"
},
"logo_image" : {
"type" : "string" ,
"format" : "binary" ,
"title" : "Company Logo Image"
},
"description" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Description"
},
"activity_scopes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"title" : "Company Activity Scopes"
},
"documents" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "Company Documents"
},
"title" : "Company Documents"
}
},
"required" : [
"activity_scopes" ,
"address" ,
"description" ,
"documents" ,
"logo_image" ,
"tax_identification_number" ,
"title"
]
}
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"title" : "string" ,
"tax_identification_number" : "string" ,
"address" : "string" ,
"logo_image" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"description" : "string" ,
"activity_scopes" : [
"string"
],
"documents" : [
"6758bc3e-960b-4450-a0d7-68b4d86285cd"
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"tax_identification_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"address" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Corporate Address"
},
"logo_image" : {
"type" : "string" ,
"format" : "binary" ,
"title" : "Company Logo Image"
},
"description" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Description"
},
"activity_scopes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"title" : "Company Activity Scopes"
},
"documents" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "Company Documents"
},
"title" : "Company Documents"
}
},
"required" : [
"activity_scopes" ,
"address" ,
"description" ,
"documents" ,
"logo_image" ,
"tax_identification_number" ,
"title"
]
}
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"title" : "string" ,
"tax_identification_number" : "string" ,
"address" : "string" ,
"logo_image" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"description" : "string" ,
"activity_scopes" : [
"string"
],
"documents" : [
"150c7031-3846-442a-a0c7-3f3b5190a65f"
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"tax_identification_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"address" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Corporate Address"
},
"logo_image" : {
"type" : "string" ,
"format" : "binary" ,
"title" : "Company Logo Image"
},
"description" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Description"
},
"activity_scopes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"title" : "Company Activity Scopes"
},
"documents" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "Company Documents"
},
"title" : "Company Documents"
}
},
"required" : [
"activity_scopes" ,
"address" ,
"description" ,
"documents" ,
"logo_image" ,
"tax_identification_number" ,
"title"
]
}
Responses
HTTP 201 Created
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 {
"id" : "282ea167-7449-4c24-a235-6cbb91eb571c" ,
"title" : "string" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"tax_identification_number" : "string" ,
"address" : "string" ,
"logo_image" : "string" ,
"description" : "string" ,
"activity_scopes" : [
"string"
],
"documents" : [
"7df25cef-9fa8-4ba3-ae7b-abcb6778312e"
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"title" : {
"type" : "string" ,
"maxLength" : 255
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"tax_identification_number" : {
"type" : "string" ,
"maxLength" : 128
},
"address" : {
"type" : "string" ,
"title" : "Company Corporate Address"
},
"logo_image" : {
"type" : "string" ,
"format" : "uri" ,
"title" : "Company Logo Image"
},
"description" : {
"type" : "string" ,
"title" : "Company Description"
},
"activity_scopes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"maxLength" : 128
},
"title" : "Company Activity Scopes"
},
"documents" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "Company Documents"
},
"title" : "Company Documents"
}
},
"required" : [
"activity_scopes" ,
"address" ,
"created_at" ,
"description" ,
"documents" ,
"id" ,
"logo_image" ,
"tax_identification_number" ,
"title" ,
"updated_at"
]
}
GET
/api/v1/company-profile/{id}
Get company
Description
Retrieve specific company
id * (required)
path
string
Company identifier (id)
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 {
"id" : "94d3f52a-0f23-4c6b-a54a-ad0ca9fe47ae" ,
"title" : "string" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"tax_identification_number" : "string" ,
"address" : "string" ,
"logo_image" : "string" ,
"description" : "string" ,
"activity_scopes" : [
"string"
],
"documents" : [
"f39aac7b-6b2a-4901-a1e3-155dccbe55a8"
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"title" : {
"type" : "string" ,
"maxLength" : 255
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"tax_identification_number" : {
"type" : "string" ,
"maxLength" : 128
},
"address" : {
"type" : "string" ,
"title" : "Company Corporate Address"
},
"logo_image" : {
"type" : "string" ,
"format" : "uri" ,
"title" : "Company Logo Image"
},
"description" : {
"type" : "string" ,
"title" : "Company Description"
},
"activity_scopes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"maxLength" : 128
},
"title" : "Company Activity Scopes"
},
"documents" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "Company Documents"
},
"title" : "Company Documents"
}
},
"required" : [
"activity_scopes" ,
"address" ,
"created_at" ,
"description" ,
"documents" ,
"id" ,
"logo_image" ,
"tax_identification_number" ,
"title" ,
"updated_at"
]
}
PATCH
/api/v1/company-profile/{id}
Update company
Description
Update some fields of specific company
id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"title" : "string" ,
"tax_identification_number" : "string" ,
"address" : "string" ,
"logo_image" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"description" : "string" ,
"activity_scopes" : [
"string"
],
"documents" : [
"8c6d052e-d43e-4dac-bcab-5fd1058d7361"
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"tax_identification_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"address" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Corporate Address"
},
"logo_image" : {
"type" : "string" ,
"format" : "binary" ,
"title" : "Company Logo Image"
},
"description" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Description"
},
"activity_scopes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"title" : "Company Activity Scopes"
},
"documents" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "Company Documents"
},
"title" : "Company Documents"
}
}
}
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"title" : "string" ,
"tax_identification_number" : "string" ,
"address" : "string" ,
"logo_image" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"description" : "string" ,
"activity_scopes" : [
"string"
],
"documents" : [
"7eb55f4e-184a-454f-af10-8d82c1b9a7c1"
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"tax_identification_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"address" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Corporate Address"
},
"logo_image" : {
"type" : "string" ,
"format" : "binary" ,
"title" : "Company Logo Image"
},
"description" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Description"
},
"activity_scopes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"title" : "Company Activity Scopes"
},
"documents" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "Company Documents"
},
"title" : "Company Documents"
}
}
}
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"title" : "string" ,
"tax_identification_number" : "string" ,
"address" : "string" ,
"logo_image" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"description" : "string" ,
"activity_scopes" : [
"string"
],
"documents" : [
"03a32ef0-ed71-48ea-8254-e4d52c510ff0"
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"tax_identification_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"address" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Corporate Address"
},
"logo_image" : {
"type" : "string" ,
"format" : "binary" ,
"title" : "Company Logo Image"
},
"description" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Company Description"
},
"activity_scopes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 128
},
"title" : "Company Activity Scopes"
},
"documents" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "Company Documents"
},
"title" : "Company Documents"
}
}
}
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 {
"id" : "a71adf94-a57d-4027-ac0e-45d037932420" ,
"title" : "string" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"tax_identification_number" : "string" ,
"address" : "string" ,
"logo_image" : "string" ,
"description" : "string" ,
"activity_scopes" : [
"string"
],
"documents" : [
"0d47d139-e7de-47bf-805c-1dbba75b4935"
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"title" : {
"type" : "string" ,
"maxLength" : 255
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"tax_identification_number" : {
"type" : "string" ,
"maxLength" : 128
},
"address" : {
"type" : "string" ,
"title" : "Company Corporate Address"
},
"logo_image" : {
"type" : "string" ,
"format" : "uri" ,
"title" : "Company Logo Image"
},
"description" : {
"type" : "string" ,
"title" : "Company Description"
},
"activity_scopes" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"maxLength" : 128
},
"title" : "Company Activity Scopes"
},
"documents" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "Company Documents"
},
"title" : "Company Documents"
}
},
"required" : [
"activity_scopes" ,
"address" ,
"created_at" ,
"description" ,
"documents" ,
"id" ,
"logo_image" ,
"tax_identification_number" ,
"title" ,
"updated_at"
]
}
DELETE
/api/v1/company-profile/{id}
Delete company
Description
Delete specific company
id * (required)
path
string
-
Responses
HTTP 204 No Content
Datasets
GET
/api/v1/datasets/country/
List countries
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "e5996ad4-05b4-41ce-a3c9-5ffa62824955" ,
"code" : "string" ,
"title" : "string"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Country"
}
}
}
}
GET
/api/v1/datasets/country/{country_code}
Get country by code
country_code * (required)
path
string
-
Responses
HTTP 200 OK
application/json
JSON {
"id" : "8d53f0e1-e786-4e54-8528-7206fab2eb76" ,
"code" : "string" ,
"title" : "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"code" : {
"type" : "string" ,
"title" : "Country Code (ISO 3166-2)" ,
"maxLength" : 2
},
"title" : {
"type" : "string" ,
"maxLength" : 255
}
},
"required" : [
"code" ,
"id" ,
"title"
]
}
GET
/api/v1/datasets/country/{country_code} /region
List country regions
Description
List specific country regions
country_code * (required)
path
string
-
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "0bc22f5c-2507-43c8-a89c-3265c37b1069" ,
"code" : "string" ,
"title" : "string"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Region"
}
}
}
}
GET
/api/v1/datasets/country/{country_code} /region/{region_code}
Get country region by code
country_code * (required)
path
string
-
region_code * (required)
path
string
-
Responses
HTTP 200 OK
application/json
JSON {
"id" : "3174afce-0274-4b1e-9084-3a71f881549a" ,
"code" : "string" ,
"title" : "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"code" : {
"type" : "string" ,
"title" : "Region Code" ,
"maxLength" : 8
},
"title" : {
"type" : "string" ,
"maxLength" : 255
}
},
"required" : [
"code" ,
"id" ,
"title"
]
}
GET
/api/v1/datasets/language/
List languages
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "f0be9294-f8ab-4b9f-bc0f-a37452fb1c3e" ,
"code" : "string" ,
"title" : "string" ,
"title_national" : "string"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Language"
}
}
}
}
GET
/api/v1/datasets/language/{language_code}
Get languages by code
language_code * (required)
path
string
-
Responses
HTTP 200 OK
application/json
JSON {
"id" : "b742ef66-3e84-4ee9-9d69-6d1f29e061b7" ,
"code" : "string" ,
"title" : "string" ,
"title_national" : "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"code" : {
"type" : "string" ,
"title" : "Language Code (ISO 639-1)" ,
"maxLength" : 2
},
"title" : {
"type" : "string" ,
"maxLength" : 255
},
"title_national" : {
"type" : "string" ,
"maxLength" : 255
}
},
"required" : [
"code" ,
"id" ,
"title" ,
"title_national"
]
}
GET
/api/v1/datasets/skill/
List skills
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "040b2718-8205-4200-9dc2-eab43cfa9e9d" ,
"code" : "string" ,
"title" : "string" ,
"description" : "string"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Skill"
}
}
}
}
GET
/api/v1/datasets/skill/{code}
Get skill by code
code * (required)
path
string
-
Responses
HTTP 200 OK
application/json
JSON {
"id" : "6388fb51-163a-4649-b91c-392c78961908" ,
"code" : "string" ,
"title" : "string" ,
"description" : "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"code" : {
"type" : "string" ,
"title" : "Skill Code" ,
"maxLength" : 12
},
"title" : {
"type" : "string" ,
"maxLength" : 255
},
"description" : {
"type" : "string" ,
"title" : "Skill description"
}
},
"required" : [
"code" ,
"id" ,
"title"
]
}
GET
/api/v1/datasets/specialization/
List specializations
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "aeaddb92-3059-41a4-b5cf-955442e6c8af" ,
"code" : "string" ,
"qualification" : "string" ,
"sector" : "string" ,
"specialization" : "string" ,
"occupation" : "string"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Specialization"
}
}
}
}
GET
/api/v1/datasets/specialization/{code}
Get specialization by code
code * (required)
path
string
-
Responses
HTTP 200 OK
application/json
JSON {
"id" : "82b2a306-689e-4da5-9212-a5ec60c6c55d" ,
"code" : "string" ,
"qualification" : "string" ,
"sector" : "string" ,
"specialization" : "string" ,
"occupation" : "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"code" : {
"type" : "string" ,
"maxLength" : 16
},
"qualification" : {
"type" : "string"
},
"sector" : {
"type" : "string"
},
"specialization" : {
"type" : "string"
},
"occupation" : {
"type" : "string"
}
},
"required" : [
"code" ,
"id"
]
}
Storage
GET
/api/v1/storage/download/{asset_type} /{asset_id} /
Download asset from storage
asset_id * (required)
path
string
-
asset_type * (required)
path
string
-
document_type
query
string
-
Responses
HTTP 200 OK
PUT
/api/v1/storage/upload/
Upload file to storage
Request body
multipart/form-data
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"files" : [
"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
],
"data" : [
{
"document_type" : "Passport" ,
"caption" : "string" ,
"owned_by_worker" : "string" ,
"owned_by_company" : "string"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 {
"type" : "object" ,
"properties" : {
"files" : {
"type" : "array" ,
"items" : {
"type" : "string" ,
"format" : "binary"
}
},
"data" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/FileMetadataRequest"
}
}
},
"required" : [
"data" ,
"files"
]
}
Responses
HTTP 200 OK
User Profile
GET
/api/v1/user-profile/
List user profiles
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "cee0811d-7a32-412a-9a0d-96f5783a6180" ,
"skills" : [
{
"id" : "ff2b1b39-4cf8-44f3-abf0-b276a755d491" ,
"code" : "string" ,
"title" : "string" ,
"description" : "string"
}
],
"specializations" : [
{
"id" : "1a272d7a-2697-4ccb-bba0-35b611f79f1d" ,
"code" : "string" ,
"qualification" : "string" ,
"sector" : "string" ,
"specialization" : "string" ,
"occupation" : "string"
}
],
"title" : "string" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "string" ,
"owner" : "79408e5c-9388-493f-822f-2bc9e6184b70"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/UserProfileDetail"
}
}
}
}
POST
/api/v1/user-profile/
Create new user profile
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14 {
"title" : "string" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"owner" : "37bb1630-aec5-4a52-81c9-13c1bdbbd97c"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"verification_status" : {
"$ref" : "#/components/schemas/VerificationStatusEnum"
},
"full_name" : {
"type" : "string" ,
"minLength" : 1
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 24
},
"primary_email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"maxLength" : 254
},
"additional_email" : {
"type" : "string" ,
"format" : "email" ,
"nullable" : true ,
"maxLength" : 254
},
"gender" : {
"$ref" : "#/components/schemas/GenderEnum"
},
"biography" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"title" : "About me"
},
"biography_verification_status" : {
"$ref" : "#/components/schemas/BiographyVerificationStatusEnum"
},
"address" : {
"type" : "string" ,
"minLength" : 1
},
"photo" : {
"type" : "string" ,
"format" : "binary" ,
"nullable" : true
},
"owner" : {
"type" : "string" ,
"format" : "uuid"
}
},
"required" : [
"address" ,
"full_name" ,
"owner" ,
"phone_number" ,
"primary_email" ,
"title"
]
}
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14 {
"title" : "string" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"owner" : "09e0e974-a8b4-412a-8510-d24c806e114c"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"verification_status" : {
"$ref" : "#/components/schemas/VerificationStatusEnum"
},
"full_name" : {
"type" : "string" ,
"minLength" : 1
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 24
},
"primary_email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"maxLength" : 254
},
"additional_email" : {
"type" : "string" ,
"format" : "email" ,
"nullable" : true ,
"maxLength" : 254
},
"gender" : {
"$ref" : "#/components/schemas/GenderEnum"
},
"biography" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"title" : "About me"
},
"biography_verification_status" : {
"$ref" : "#/components/schemas/BiographyVerificationStatusEnum"
},
"address" : {
"type" : "string" ,
"minLength" : 1
},
"photo" : {
"type" : "string" ,
"format" : "binary" ,
"nullable" : true
},
"owner" : {
"type" : "string" ,
"format" : "uuid"
}
},
"required" : [
"address" ,
"full_name" ,
"owner" ,
"phone_number" ,
"primary_email" ,
"title"
]
}
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14 {
"title" : "string" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"owner" : "05413d3e-7694-434d-af57-9e16da2fefa2"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"verification_status" : {
"$ref" : "#/components/schemas/VerificationStatusEnum"
},
"full_name" : {
"type" : "string" ,
"minLength" : 1
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 24
},
"primary_email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"maxLength" : 254
},
"additional_email" : {
"type" : "string" ,
"format" : "email" ,
"nullable" : true ,
"maxLength" : 254
},
"gender" : {
"$ref" : "#/components/schemas/GenderEnum"
},
"biography" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"title" : "About me"
},
"biography_verification_status" : {
"$ref" : "#/components/schemas/BiographyVerificationStatusEnum"
},
"address" : {
"type" : "string" ,
"minLength" : 1
},
"photo" : {
"type" : "string" ,
"format" : "binary" ,
"nullable" : true
},
"owner" : {
"type" : "string" ,
"format" : "uuid"
}
},
"required" : [
"address" ,
"full_name" ,
"owner" ,
"phone_number" ,
"primary_email" ,
"title"
]
}
Responses
HTTP 201 Created
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35 {
"id" : "425d8d4c-29d2-4876-bfef-75573212c6f5" ,
"skills" : [
{
"id" : "dedc8cce-3d3c-450f-b51f-f92678f960c9" ,
"code" : "string" ,
"title" : "string" ,
"description" : "string"
}
],
"specializations" : [
{
"id" : "f617fbb1-2b9c-4b9a-a5c5-fe5428f1c231" ,
"code" : "string" ,
"qualification" : "string" ,
"sector" : "string" ,
"specialization" : "string" ,
"occupation" : "string"
}
],
"title" : "string" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "string" ,
"owner" : "c3496173-aac3-4196-aeaa-ca8de435ffbd"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"skills" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Skill"
},
"readOnly" : true
},
"specializations" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Specialization"
},
"readOnly" : true
},
"title" : {
"type" : "string" ,
"maxLength" : 255
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"verification_status" : {
"$ref" : "#/components/schemas/VerificationStatusEnum"
},
"full_name" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"maxLength" : 24
},
"primary_email" : {
"type" : "string" ,
"format" : "email" ,
"maxLength" : 254
},
"additional_email" : {
"type" : "string" ,
"format" : "email" ,
"nullable" : true ,
"maxLength" : 254
},
"gender" : {
"$ref" : "#/components/schemas/GenderEnum"
},
"biography" : {
"type" : "string" ,
"nullable" : true ,
"title" : "About me"
},
"biography_verification_status" : {
"$ref" : "#/components/schemas/BiographyVerificationStatusEnum"
},
"address" : {
"type" : "string"
},
"photo" : {
"type" : "string" ,
"format" : "uri" ,
"nullable" : true
},
"owner" : {
"type" : "string" ,
"format" : "uuid"
}
},
"required" : [
"address" ,
"created_at" ,
"full_name" ,
"id" ,
"owner" ,
"phone_number" ,
"primary_email" ,
"skills" ,
"specializations" ,
"title" ,
"updated_at"
]
}
GET
/api/v1/user-profile/{id}
Get user profile
Description
Retrieve specific user profile
id * (required)
path
string
User profile identifier (id)
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35 {
"id" : "1af87ff1-1f92-4a77-b178-0a823fc9d0ff" ,
"skills" : [
{
"id" : "aa8e184a-7be8-4e9b-89f0-c9cd47298832" ,
"code" : "string" ,
"title" : "string" ,
"description" : "string"
}
],
"specializations" : [
{
"id" : "462b76ca-9eb6-4569-a22d-3954d898fc73" ,
"code" : "string" ,
"qualification" : "string" ,
"sector" : "string" ,
"specialization" : "string" ,
"occupation" : "string"
}
],
"title" : "string" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "string" ,
"owner" : "632e1623-db2d-437f-bc4f-83f5af84fb9f"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"skills" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Skill"
},
"readOnly" : true
},
"specializations" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Specialization"
},
"readOnly" : true
},
"title" : {
"type" : "string" ,
"maxLength" : 255
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"verification_status" : {
"$ref" : "#/components/schemas/VerificationStatusEnum"
},
"full_name" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"maxLength" : 24
},
"primary_email" : {
"type" : "string" ,
"format" : "email" ,
"maxLength" : 254
},
"additional_email" : {
"type" : "string" ,
"format" : "email" ,
"nullable" : true ,
"maxLength" : 254
},
"gender" : {
"$ref" : "#/components/schemas/GenderEnum"
},
"biography" : {
"type" : "string" ,
"nullable" : true ,
"title" : "About me"
},
"biography_verification_status" : {
"$ref" : "#/components/schemas/BiographyVerificationStatusEnum"
},
"address" : {
"type" : "string"
},
"photo" : {
"type" : "string" ,
"format" : "uri" ,
"nullable" : true
},
"owner" : {
"type" : "string" ,
"format" : "uuid"
}
},
"required" : [
"address" ,
"created_at" ,
"full_name" ,
"id" ,
"owner" ,
"phone_number" ,
"primary_email" ,
"skills" ,
"specializations" ,
"title" ,
"updated_at"
]
}
PATCH
/api/v1/user-profile/{id}
Update user profile
Description
Update some fields of specific user profile
id * (required)
path
string
User profile identifier (id)
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14 {
"title" : "string" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"owner" : "fdb551e0-dff1-49a9-80f8-a00d48db6c8a"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"verification_status" : {
"$ref" : "#/components/schemas/VerificationStatusEnum"
},
"full_name" : {
"type" : "string" ,
"minLength" : 1
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 24
},
"primary_email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"maxLength" : 254
},
"additional_email" : {
"type" : "string" ,
"format" : "email" ,
"nullable" : true ,
"maxLength" : 254
},
"gender" : {
"$ref" : "#/components/schemas/GenderEnum"
},
"biography" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"title" : "About me"
},
"biography_verification_status" : {
"$ref" : "#/components/schemas/BiographyVerificationStatusEnum"
},
"address" : {
"type" : "string" ,
"minLength" : 1
},
"photo" : {
"type" : "string" ,
"format" : "binary" ,
"nullable" : true
},
"owner" : {
"type" : "string" ,
"format" : "uuid"
}
}
}
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14 {
"title" : "string" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"owner" : "628c2e2c-7be1-4835-abf0-35894439f8e6"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"verification_status" : {
"$ref" : "#/components/schemas/VerificationStatusEnum"
},
"full_name" : {
"type" : "string" ,
"minLength" : 1
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 24
},
"primary_email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"maxLength" : 254
},
"additional_email" : {
"type" : "string" ,
"format" : "email" ,
"nullable" : true ,
"maxLength" : 254
},
"gender" : {
"$ref" : "#/components/schemas/GenderEnum"
},
"biography" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"title" : "About me"
},
"biography_verification_status" : {
"$ref" : "#/components/schemas/BiographyVerificationStatusEnum"
},
"address" : {
"type" : "string" ,
"minLength" : 1
},
"photo" : {
"type" : "string" ,
"format" : "binary" ,
"nullable" : true
},
"owner" : {
"type" : "string" ,
"format" : "uuid"
}
}
}
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14 {
"title" : "string" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=" ,
"owner" : "f3b4b78f-78cb-41f7-9669-889e7ffa5f40"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59 {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 255
},
"verification_status" : {
"$ref" : "#/components/schemas/VerificationStatusEnum"
},
"full_name" : {
"type" : "string" ,
"minLength" : 1
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 24
},
"primary_email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"maxLength" : 254
},
"additional_email" : {
"type" : "string" ,
"format" : "email" ,
"nullable" : true ,
"maxLength" : 254
},
"gender" : {
"$ref" : "#/components/schemas/GenderEnum"
},
"biography" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"title" : "About me"
},
"biography_verification_status" : {
"$ref" : "#/components/schemas/BiographyVerificationStatusEnum"
},
"address" : {
"type" : "string" ,
"minLength" : 1
},
"photo" : {
"type" : "string" ,
"format" : "binary" ,
"nullable" : true
},
"owner" : {
"type" : "string" ,
"format" : "uuid"
}
}
}
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35 {
"id" : "e577a01e-4291-4ef5-b7fe-e5f05b805240" ,
"skills" : [
{
"id" : "d93b4ce3-8e13-43c0-948a-11f620456cf5" ,
"code" : "string" ,
"title" : "string" ,
"description" : "string"
}
],
"specializations" : [
{
"id" : "1d643d85-fa73-4217-bfd1-b56bc47dd853" ,
"code" : "string" ,
"qualification" : "string" ,
"sector" : "string" ,
"specialization" : "string" ,
"occupation" : "string"
}
],
"title" : "string" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"verification_status" : "Unconfirmed" ,
"full_name" : "string" ,
"phone_number" : "string" ,
"primary_email" : "[email protected] " ,
"additional_email" : "[email protected] " ,
"gender" : "Male" ,
"biography" : "string" ,
"biography_verification_status" : "Unconfirmed" ,
"address" : "string" ,
"photo" : "string" ,
"owner" : "486c4f2f-35f6-45f6-b1da-c41ba44fc072"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"skills" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Skill"
},
"readOnly" : true
},
"specializations" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/Specialization"
},
"readOnly" : true
},
"title" : {
"type" : "string" ,
"maxLength" : 255
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"verification_status" : {
"$ref" : "#/components/schemas/VerificationStatusEnum"
},
"full_name" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"maxLength" : 24
},
"primary_email" : {
"type" : "string" ,
"format" : "email" ,
"maxLength" : 254
},
"additional_email" : {
"type" : "string" ,
"format" : "email" ,
"nullable" : true ,
"maxLength" : 254
},
"gender" : {
"$ref" : "#/components/schemas/GenderEnum"
},
"biography" : {
"type" : "string" ,
"nullable" : true ,
"title" : "About me"
},
"biography_verification_status" : {
"$ref" : "#/components/schemas/BiographyVerificationStatusEnum"
},
"address" : {
"type" : "string"
},
"photo" : {
"type" : "string" ,
"format" : "uri" ,
"nullable" : true
},
"owner" : {
"type" : "string" ,
"format" : "uuid"
}
},
"required" : [
"address" ,
"created_at" ,
"full_name" ,
"id" ,
"owner" ,
"phone_number" ,
"primary_email" ,
"skills" ,
"specializations" ,
"title" ,
"updated_at"
]
}
DELETE
/api/v1/user-profile/{id}
Delete user profile
Description
Delete specific user profile
id * (required)
path
string
User profile identifier (id)
Responses
HTTP 204 No Content
User Profile Attachment
GET
/api/v1/user-profile/{id} /attachment
List user profile attachments
Description
List specific user profile attachments
id * (required)
path
string
User profile identifier (id)
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "576ebc3c-f431-42ff-8c2e-6d34758562bb" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "9c8d02be-7154-4f0d-84cc-9d7b5aed9c88" ,
"document_asset" : "5a609f71-1e3d-4894-9c65-40b264710c2d"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/AttachmentDetail"
}
}
}
}
POST
/api/v1/user-profile/{id} /attachment
Create new user profile attachment
id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "49f536fa-f88f-42b6-80b7-b4f8241ea068" ,
"document_asset" : "b8c1c5fd-d4d8-4bf9-a8d5-996ee7771037"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47 {
"type" : "object" ,
"properties" : {
"issuance_date" : {
"type" : "string" ,
"format" : "date"
},
"issuer" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"expiration_date" : {
"type" : "string" ,
"format" : "date" ,
"nullable" : true
},
"identification_value" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"maxLength" : 255
},
"additional_document_info" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"additional_document_fields" : {
"nullable" : true
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile"
},
"document_asset" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true
}
},
"required" : [
"issuance_date"
]
}
JSON {
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "456ab3db-1461-47c4-9ad0-331387d361f1" ,
"document_asset" : "30474b23-6baa-4404-a7cf-428b808839c3"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47 {
"type" : "object" ,
"properties" : {
"issuance_date" : {
"type" : "string" ,
"format" : "date"
},
"issuer" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"expiration_date" : {
"type" : "string" ,
"format" : "date" ,
"nullable" : true
},
"identification_value" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"maxLength" : 255
},
"additional_document_info" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"additional_document_fields" : {
"nullable" : true
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile"
},
"document_asset" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true
}
},
"required" : [
"issuance_date"
]
}
JSON {
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "96204d98-dfbd-4271-9c2c-58309c8d3313" ,
"document_asset" : "cf8deb59-dd1a-4c80-aae5-dab50cea105a"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47 {
"type" : "object" ,
"properties" : {
"issuance_date" : {
"type" : "string" ,
"format" : "date"
},
"issuer" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"expiration_date" : {
"type" : "string" ,
"format" : "date" ,
"nullable" : true
},
"identification_value" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"maxLength" : 255
},
"additional_document_info" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"additional_document_fields" : {
"nullable" : true
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile"
},
"document_asset" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true
}
},
"required" : [
"issuance_date"
]
}
Responses
HTTP 201 Created
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"id" : "a4a405d3-127d-4c97-abc4-d24661e5d23d" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "161dd680-8072-477e-9297-58fb8717fa32" ,
"document_asset" : "f6f9e84c-2abe-4d83-a837-09f30162d1ba"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"issuance_date" : {
"type" : "string" ,
"format" : "date"
},
"issuer" : {
"type" : "string" ,
"nullable" : true
},
"expiration_date" : {
"type" : "string" ,
"format" : "date" ,
"nullable" : true
},
"identification_value" : {
"type" : "string" ,
"nullable" : true ,
"maxLength" : 255
},
"additional_document_info" : {
"type" : "string" ,
"nullable" : true
},
"additional_document_fields" : {
"nullable" : true
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile"
},
"document_asset" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true
}
},
"required" : [
"created_at" ,
"id" ,
"issuance_date" ,
"updated_at"
]
}
GET
/api/v1/user-profile/{id} /attachment/{attachment_id}
Get user profile attachment
Description
Retrieve specific user profile attachment
attachment_id * (required)
path
string
User profile attachment identifier (id)
id * (required)
path
string
User profile identifier (id)
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"id" : "f20085c5-dc18-4e34-bd22-ec59ad8e701c" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "b882117f-d8e4-428c-89ce-3bd56aed6f3c" ,
"document_asset" : "8bac3e3a-65d0-4a10-8a83-89ffd57fae1c"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"issuance_date" : {
"type" : "string" ,
"format" : "date"
},
"issuer" : {
"type" : "string" ,
"nullable" : true
},
"expiration_date" : {
"type" : "string" ,
"format" : "date" ,
"nullable" : true
},
"identification_value" : {
"type" : "string" ,
"nullable" : true ,
"maxLength" : 255
},
"additional_document_info" : {
"type" : "string" ,
"nullable" : true
},
"additional_document_fields" : {
"nullable" : true
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile"
},
"document_asset" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true
}
},
"required" : [
"created_at" ,
"id" ,
"issuance_date" ,
"updated_at"
]
}
PATCH
/api/v1/user-profile/{id} /attachment/{attachment_id}
Update user profile attachment
Description
Update some fields of specific user profile attachment
attachment_id * (required)
path
string
-
id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "16ceb779-bc99-465a-912c-dd7549ece856" ,
"document_asset" : "b7b9b88c-c355-4bb1-a0c0-b280a90e6fa2"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44 {
"type" : "object" ,
"properties" : {
"issuance_date" : {
"type" : "string" ,
"format" : "date"
},
"issuer" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"expiration_date" : {
"type" : "string" ,
"format" : "date" ,
"nullable" : true
},
"identification_value" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"maxLength" : 255
},
"additional_document_info" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"additional_document_fields" : {
"nullable" : true
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile"
},
"document_asset" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true
}
}
}
JSON {
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "53b90d7f-64a2-4056-aff2-8257cc5d773d" ,
"document_asset" : "937e835f-6f93-46de-b756-3fa591e68eaf"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44 {
"type" : "object" ,
"properties" : {
"issuance_date" : {
"type" : "string" ,
"format" : "date"
},
"issuer" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"expiration_date" : {
"type" : "string" ,
"format" : "date" ,
"nullable" : true
},
"identification_value" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"maxLength" : 255
},
"additional_document_info" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"additional_document_fields" : {
"nullable" : true
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile"
},
"document_asset" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true
}
}
}
JSON {
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "28806868-06c5-4ea1-8c7b-596d2b7c22a4" ,
"document_asset" : "e945a89e-2b11-443d-97e2-36314f95cf24"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44 {
"type" : "object" ,
"properties" : {
"issuance_date" : {
"type" : "string" ,
"format" : "date"
},
"issuer" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"expiration_date" : {
"type" : "string" ,
"format" : "date" ,
"nullable" : true
},
"identification_value" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1 ,
"maxLength" : 255
},
"additional_document_info" : {
"type" : "string" ,
"nullable" : true ,
"minLength" : 1
},
"additional_document_fields" : {
"nullable" : true
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile"
},
"document_asset" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true
}
}
}
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13 {
"id" : "268ba93d-306e-4a8d-a468-867722276257" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"issuance_date" : "2022-04-13" ,
"issuer" : "string" ,
"expiration_date" : "2022-04-13" ,
"identification_value" : "string" ,
"additional_document_info" : "string" ,
"additional_document_fields" : null ,
"profile" : "44eff241-213e-49e9-b1eb-174330254034" ,
"document_asset" : "c11370c3-7708-40b2-bb52-30ebc8e53391"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"issuance_date" : {
"type" : "string" ,
"format" : "date"
},
"issuer" : {
"type" : "string" ,
"nullable" : true
},
"expiration_date" : {
"type" : "string" ,
"format" : "date" ,
"nullable" : true
},
"identification_value" : {
"type" : "string" ,
"nullable" : true ,
"maxLength" : 255
},
"additional_document_info" : {
"type" : "string" ,
"nullable" : true
},
"additional_document_fields" : {
"nullable" : true
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile"
},
"document_asset" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true
}
},
"required" : [
"created_at" ,
"id" ,
"issuance_date" ,
"updated_at"
]
}
DELETE
/api/v1/user-profile/{id} /attachment/{attachment_id}
Delete user profile attachment
Description
Delete specific user profile attachment
attachment_id * (required)
path
string
-
id * (required)
path
string
-
Responses
HTTP 204 No Content
User Profile Contact Info
GET
/api/v1/user-profile/{id} /contact-info
List user profile contacts
Description
List specific user profile contacts
id * (required)
path
string
User profile identifier (id)
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "975552be-e9da-454b-a1a2-95ce72406d0e" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "22fd05ad-233a-44fb-a262-d92450493f4b"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/ProfileContactInfoDetail"
}
}
}
}
POST
/api/v1/user-profile/{id} /contact-info
Create new contact for user profile
id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "d1d7c052-57a6-4d97-81aa-5b2eab8b1410"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61 {
"type" : "object" ,
"properties" : {
"contact_type" : {
"$ref" : "#/components/schemas/ContactTypeEnum"
},
"contact_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"salutation_type" : {
"allOf" : [
{
"$ref" : "#/components/schemas/SalutationTypeEnum"
}
],
"title" : "Salutation"
},
"salutation_value" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact phone number" ,
"maxLength" : 32
},
"email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"title" : "Contact e-mail" ,
"maxLength" : 254
},
"address" : {
"type" : "string" ,
"nullable" : true ,
"title" : "Contact address"
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_number" ,
"contact_name" ,
"email" ,
"phone_number" ,
"profile" ,
"salutation_type"
]
}
JSON {
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "7effca50-3346-414b-a79d-47eb1faeadb9"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61 {
"type" : "object" ,
"properties" : {
"contact_type" : {
"$ref" : "#/components/schemas/ContactTypeEnum"
},
"contact_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"salutation_type" : {
"allOf" : [
{
"$ref" : "#/components/schemas/SalutationTypeEnum"
}
],
"title" : "Salutation"
},
"salutation_value" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact phone number" ,
"maxLength" : 32
},
"email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"title" : "Contact e-mail" ,
"maxLength" : 254
},
"address" : {
"type" : "string" ,
"nullable" : true ,
"title" : "Contact address"
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_number" ,
"contact_name" ,
"email" ,
"phone_number" ,
"profile" ,
"salutation_type"
]
}
JSON {
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "aac19795-3b55-48a6-aaf8-ea7856e57a7e"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61 {
"type" : "object" ,
"properties" : {
"contact_type" : {
"$ref" : "#/components/schemas/ContactTypeEnum"
},
"contact_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"salutation_type" : {
"allOf" : [
{
"$ref" : "#/components/schemas/SalutationTypeEnum"
}
],
"title" : "Salutation"
},
"salutation_value" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact phone number" ,
"maxLength" : 32
},
"email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"title" : "Contact e-mail" ,
"maxLength" : 254
},
"address" : {
"type" : "string" ,
"nullable" : true ,
"title" : "Contact address"
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_number" ,
"contact_name" ,
"email" ,
"phone_number" ,
"profile" ,
"salutation_type"
]
}
Responses
HTTP 201 Created
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14 {
"id" : "ffde5b0e-7f21-45eb-b280-1aaf82b42d71" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "20daee05-f8aa-45e8-bab0-b30102f8d001"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"contact_type" : {
"$ref" : "#/components/schemas/ContactTypeEnum"
},
"contact_name" : {
"type" : "string" ,
"maxLength" : 1024
},
"salutation_type" : {
"allOf" : [
{
"$ref" : "#/components/schemas/SalutationTypeEnum"
}
],
"title" : "Salutation"
},
"salutation_value" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"title" : "Contact phone number" ,
"maxLength" : 32
},
"email" : {
"type" : "string" ,
"format" : "email" ,
"title" : "Contact e-mail" ,
"maxLength" : 254
},
"address" : {
"type" : "string" ,
"nullable" : true ,
"title" : "Contact address"
},
"account_number" : {
"type" : "string" ,
"title" : "Contact account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_number" ,
"contact_name" ,
"created_at" ,
"email" ,
"id" ,
"phone_number" ,
"profile" ,
"salutation_type" ,
"updated_at"
]
}
GET
/api/v1/user-profile/{id} /contact-info/{contact_id}
Get user profile contact
Description
Retrieve specific user profile contact
contact_id * (required)
path
string
-
id * (required)
path
string
User profile identifier (id)
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14 {
"id" : "f6ea5ded-639b-487c-b54c-8d554b833de8" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "0978f91a-7272-4e91-b89e-0f0cc25c41dd"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"contact_type" : {
"$ref" : "#/components/schemas/ContactTypeEnum"
},
"contact_name" : {
"type" : "string" ,
"maxLength" : 1024
},
"salutation_type" : {
"allOf" : [
{
"$ref" : "#/components/schemas/SalutationTypeEnum"
}
],
"title" : "Salutation"
},
"salutation_value" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"title" : "Contact phone number" ,
"maxLength" : 32
},
"email" : {
"type" : "string" ,
"format" : "email" ,
"title" : "Contact e-mail" ,
"maxLength" : 254
},
"address" : {
"type" : "string" ,
"nullable" : true ,
"title" : "Contact address"
},
"account_number" : {
"type" : "string" ,
"title" : "Contact account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_number" ,
"contact_name" ,
"created_at" ,
"email" ,
"id" ,
"phone_number" ,
"profile" ,
"salutation_type" ,
"updated_at"
]
}
PATCH
/api/v1/user-profile/{id} /contact-info/{contact_id}
Update user profile contact
Description
Update some fields of specific user profile contact
contact_id * (required)
path
string
-
id * (required)
path
string
User profile identifier (id)
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "f997af61-6dac-45af-ac33-ce8332ef99aa"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53 {
"type" : "object" ,
"properties" : {
"contact_type" : {
"$ref" : "#/components/schemas/ContactTypeEnum"
},
"contact_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"salutation_type" : {
"allOf" : [
{
"$ref" : "#/components/schemas/SalutationTypeEnum"
}
],
"title" : "Salutation"
},
"salutation_value" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact phone number" ,
"maxLength" : 32
},
"email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"title" : "Contact e-mail" ,
"maxLength" : 254
},
"address" : {
"type" : "string" ,
"nullable" : true ,
"title" : "Contact address"
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
}
}
JSON {
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "0d6fef30-7d03-418d-9e17-4aaff956b479"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53 {
"type" : "object" ,
"properties" : {
"contact_type" : {
"$ref" : "#/components/schemas/ContactTypeEnum"
},
"contact_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"salutation_type" : {
"allOf" : [
{
"$ref" : "#/components/schemas/SalutationTypeEnum"
}
],
"title" : "Salutation"
},
"salutation_value" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact phone number" ,
"maxLength" : 32
},
"email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"title" : "Contact e-mail" ,
"maxLength" : 254
},
"address" : {
"type" : "string" ,
"nullable" : true ,
"title" : "Contact address"
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
}
}
JSON {
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "5e3e04cc-b510-42c4-aeb7-5d3f6481f272"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53 {
"type" : "object" ,
"properties" : {
"contact_type" : {
"$ref" : "#/components/schemas/ContactTypeEnum"
},
"contact_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"salutation_type" : {
"allOf" : [
{
"$ref" : "#/components/schemas/SalutationTypeEnum"
}
],
"title" : "Salutation"
},
"salutation_value" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact phone number" ,
"maxLength" : 32
},
"email" : {
"type" : "string" ,
"format" : "email" ,
"minLength" : 1 ,
"title" : "Contact e-mail" ,
"maxLength" : 254
},
"address" : {
"type" : "string" ,
"nullable" : true ,
"title" : "Contact address"
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Contact account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
}
}
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14 {
"id" : "50f645a2-bdf1-4cf9-92b2-4e3486780ba9" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"contact_type" : "Normal" ,
"contact_name" : "string" ,
"salutation_type" : null ,
"salutation_value" : "string" ,
"phone_number" : "string" ,
"email" : "[email protected] " ,
"address" : "string" ,
"account_number" : "string" ,
"profile" : "acaff07f-af3c-46fe-8406-d1795ed7960f"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"contact_type" : {
"$ref" : "#/components/schemas/ContactTypeEnum"
},
"contact_name" : {
"type" : "string" ,
"maxLength" : 1024
},
"salutation_type" : {
"allOf" : [
{
"$ref" : "#/components/schemas/SalutationTypeEnum"
}
],
"title" : "Salutation"
},
"salutation_value" : {
"type" : "string"
},
"phone_number" : {
"type" : "string" ,
"title" : "Contact phone number" ,
"maxLength" : 32
},
"email" : {
"type" : "string" ,
"format" : "email" ,
"title" : "Contact e-mail" ,
"maxLength" : 254
},
"address" : {
"type" : "string" ,
"nullable" : true ,
"title" : "Contact address"
},
"account_number" : {
"type" : "string" ,
"title" : "Contact account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_number" ,
"contact_name" ,
"created_at" ,
"email" ,
"id" ,
"phone_number" ,
"profile" ,
"salutation_type" ,
"updated_at"
]
}
DELETE
/api/v1/user-profile/{id} /contact-info/{contact_id}
Delete user profile contact
Description
Delete specific user profile contact
contact_id * (required)
path
string
-
id * (required)
path
string
User profile identifier (id)
Responses
HTTP 204 No Content
User Profile Experience
GET
/api/v1/user-profile/{id} /experience
List user profile experience entries
Description
List specific user profile experience entries
id * (required)
path
string
User profile identifier (id)
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "b483f0a8-d460-4e99-b5f2-157ce7e5ca22" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string" ,
"profile" : "6bc8b558-72de-47b8-a84c-f5a7349f6000"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/ExperienceEntryDetail"
}
}
}
}
POST
/api/v1/user-profile/{id} /experience
Create new user profile experience entry
id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24 {
"type" : "object" ,
"properties" : {
"work_company" : {
"type" : "string"
},
"work_position" : {
"type" : "string"
},
"work_days_total" : {
"type" : "integer" ,
"maximum" : 2147483647 ,
"minimum" : -2147483648
},
"work_description" : {
"type" : "string" ,
"minLength" : 1
}
},
"required" : [
"work_days_total" ,
"work_description"
]
}
JSON {
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24 {
"type" : "object" ,
"properties" : {
"work_company" : {
"type" : "string"
},
"work_position" : {
"type" : "string"
},
"work_days_total" : {
"type" : "integer" ,
"maximum" : 2147483647 ,
"minimum" : -2147483648
},
"work_description" : {
"type" : "string" ,
"minLength" : 1
}
},
"required" : [
"work_days_total" ,
"work_description"
]
}
JSON {
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24 {
"type" : "object" ,
"properties" : {
"work_company" : {
"type" : "string"
},
"work_position" : {
"type" : "string"
},
"work_days_total" : {
"type" : "integer" ,
"maximum" : 2147483647 ,
"minimum" : -2147483648
},
"work_description" : {
"type" : "string" ,
"minLength" : 1
}
},
"required" : [
"work_days_total" ,
"work_description"
]
}
Responses
HTTP 201 Created
application/json
JSON {
"id" : "80f9cd8f-9110-41c0-9939-f8284559f9ce" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string" ,
"profile" : "af4bbe29-56c4-4bd3-ad35-3e991bf81246"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"work_company" : {
"type" : "string"
},
"work_position" : {
"type" : "string"
},
"work_days_total" : {
"type" : "integer" ,
"maximum" : 2147483647 ,
"minimum" : -2147483648
},
"work_description" : {
"type" : "string"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"created_at" ,
"id" ,
"profile" ,
"updated_at" ,
"work_days_total" ,
"work_description"
]
}
GET
/api/v1/user-profile/{id} /experience/{experience_entry_id}
Get user profile experience entry
Description
Retrieve specific user profile experience entry
experience_entry_id * (required)
path
string
User profile experience entry identifier (id)
id * (required)
path
string
User profile identifier (id)
Responses
HTTP 200 OK
application/json
JSON {
"id" : "1f2be06e-96ba-46bc-8104-75b7154d214b" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string" ,
"profile" : "4b6f62ef-da18-4937-a457-dafa0754f620"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"work_company" : {
"type" : "string"
},
"work_position" : {
"type" : "string"
},
"work_days_total" : {
"type" : "integer" ,
"maximum" : 2147483647 ,
"minimum" : -2147483648
},
"work_description" : {
"type" : "string"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"created_at" ,
"id" ,
"profile" ,
"updated_at" ,
"work_days_total" ,
"work_description"
]
}
PATCH
/api/v1/user-profile/{id} /experience/{experience_entry_id}
Update user profile experience entry
Description
Update some fields of specific user profile experience entry
experience_entry_id * (required)
path
string
-
id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string" ,
"profile" : "0ef04138-261e-4667-9fcc-5df4e3bda3a8"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25 {
"type" : "object" ,
"properties" : {
"work_company" : {
"type" : "string"
},
"work_position" : {
"type" : "string"
},
"work_days_total" : {
"type" : "integer" ,
"maximum" : 2147483647 ,
"minimum" : -2147483648
},
"work_description" : {
"type" : "string" ,
"minLength" : 1
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
}
}
JSON {
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string" ,
"profile" : "f22397db-0f8f-4249-acc4-b101aacff630"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25 {
"type" : "object" ,
"properties" : {
"work_company" : {
"type" : "string"
},
"work_position" : {
"type" : "string"
},
"work_days_total" : {
"type" : "integer" ,
"maximum" : 2147483647 ,
"minimum" : -2147483648
},
"work_description" : {
"type" : "string" ,
"minLength" : 1
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
}
}
JSON {
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string" ,
"profile" : "4cb7c8c8-6779-45b8-b02d-1cdd93d50906"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25 {
"type" : "object" ,
"properties" : {
"work_company" : {
"type" : "string"
},
"work_position" : {
"type" : "string"
},
"work_days_total" : {
"type" : "integer" ,
"maximum" : 2147483647 ,
"minimum" : -2147483648
},
"work_description" : {
"type" : "string" ,
"minLength" : 1
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
}
}
Responses
HTTP 200 OK
application/json
JSON {
"id" : "f4ec3afc-cd44-44ec-bb0f-237c440a13ba" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"work_company" : "string" ,
"work_position" : "string" ,
"work_days_total" : 0 ,
"work_description" : "string" ,
"profile" : "81562c90-00f9-4c14-9097-3be2da22e1ab"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"work_company" : {
"type" : "string"
},
"work_position" : {
"type" : "string"
},
"work_days_total" : {
"type" : "integer" ,
"maximum" : 2147483647 ,
"minimum" : -2147483648
},
"work_description" : {
"type" : "string"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"created_at" ,
"id" ,
"profile" ,
"updated_at" ,
"work_days_total" ,
"work_description"
]
}
DELETE
/api/v1/user-profile/{id} /experience/{experience_entry_id}
Delete user profile experience entry
Description
Delete specific user profile experience entry
experience_entry_id * (required)
path
string
-
id * (required)
path
string
-
Responses
HTTP 204 No Content
User Profile Language Knowledge
GET
/api/v1/user-profile/{id} /language-knowledge
List user profile languages knowledge
Description
List specific user profile languages knowledge
id * (required)
path
string
User profile identifier (id)
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "9fce5665-79fa-4c65-8a24-e5a16d702b8c" ,
"language" : "f8ddd47c-c339-4d6e-9732-a1193ea07230" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"is_native" : true ,
"degree" : null ,
"profile" : "97f47a7e-6fa1-43d5-bd1d-c2e727f3872d" ,
"credential_document" : "6996aa8b-01b2-4b72-9615-17fdd91db49b"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/ProfileLanguageKnowledgeDetail"
}
}
}
}
POST
/api/v1/user-profile/{id} /language-knowledge
Create new user profile language knowledge
id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"is_native" : true ,
"degree" : null ,
"profile" : "bca7e9f1-7d26-4a17-8e68-bcebf58914a9" ,
"credential_document" : "efef71de-c3e2-43fa-b2c2-a2881206e953"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32 {
"type" : "object" ,
"properties" : {
"is_native" : {
"type" : "boolean" ,
"title" : "Is native language"
},
"degree" : {
"allOf" : [
{
"$ref" : "#/components/schemas/DegreeEnum"
}
],
"title" : "Language skill degree"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
},
"credential_document" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile attachment"
}
},
"required" : [
"degree" ,
"profile"
]
}
JSON {
"is_native" : true ,
"degree" : null ,
"profile" : "0163f483-0e62-437e-9e64-eb177e99880b" ,
"credential_document" : "280568a2-1138-43e1-bde7-b56d49406137"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32 {
"type" : "object" ,
"properties" : {
"is_native" : {
"type" : "boolean" ,
"title" : "Is native language"
},
"degree" : {
"allOf" : [
{
"$ref" : "#/components/schemas/DegreeEnum"
}
],
"title" : "Language skill degree"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
},
"credential_document" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile attachment"
}
},
"required" : [
"degree" ,
"profile"
]
}
JSON {
"is_native" : true ,
"degree" : null ,
"profile" : "67e2242d-e74c-49a3-88c3-6febea7d5867" ,
"credential_document" : "21d98ab6-2861-4bb2-bc2e-b2bf9dccaf24"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32 {
"type" : "object" ,
"properties" : {
"is_native" : {
"type" : "boolean" ,
"title" : "Is native language"
},
"degree" : {
"allOf" : [
{
"$ref" : "#/components/schemas/DegreeEnum"
}
],
"title" : "Language skill degree"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
},
"credential_document" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile attachment"
}
},
"required" : [
"degree" ,
"profile"
]
}
Responses
HTTP 201 Created
application/json
JSON {
"id" : "974fa382-3ccc-4459-bb5a-01b5e9187150" ,
"language" : "7bba6aaa-ef1b-4235-a8a5-ad9b5e792245" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"is_native" : true ,
"degree" : null ,
"profile" : "625cd75b-f56b-4e58-8236-943f19196cfd" ,
"credential_document" : "a8e2941d-ab2e-4750-aa6e-8e31e7af1a44"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"language" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"is_native" : {
"type" : "boolean" ,
"title" : "Is native language"
},
"degree" : {
"allOf" : [
{
"$ref" : "#/components/schemas/DegreeEnum"
}
],
"title" : "Language skill degree"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
},
"credential_document" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile attachment"
}
},
"required" : [
"created_at" ,
"degree" ,
"id" ,
"language" ,
"profile" ,
"updated_at"
]
}
GET
/api/v1/user-profile/{id} /language-knowledge/{language_knowledge_id}
Get user profile language knowledge
Description
Retrieve specific user profile language knowledge
id * (required)
path
string
User profile identifier (id)
language_knowledge_id * (required)
path
string
User profile language knowledge identifier (id)
Responses
HTTP 200 OK
application/json
JSON {
"id" : "b9ee0007-aa74-4bbe-85a3-74e97a8ee81a" ,
"language" : "5b22118d-a91f-48b7-94d3-f19dd44e47bf" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"is_native" : true ,
"degree" : null ,
"profile" : "6e40bba9-afd3-45a7-b64c-1bc636c803ee" ,
"credential_document" : "37bd3c44-c8f1-4b89-8397-6fc44f2f471c"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"language" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"is_native" : {
"type" : "boolean" ,
"title" : "Is native language"
},
"degree" : {
"allOf" : [
{
"$ref" : "#/components/schemas/DegreeEnum"
}
],
"title" : "Language skill degree"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
},
"credential_document" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile attachment"
}
},
"required" : [
"created_at" ,
"degree" ,
"id" ,
"language" ,
"profile" ,
"updated_at"
]
}
PATCH
/api/v1/user-profile/{id} /language-knowledge/{language_knowledge_id}
Update user profile language knowledge
Description
Update some fields of specific user profile language knowledge
id * (required)
path
string
-
language_knowledge_id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"is_native" : true ,
"degree" : null ,
"profile" : "a3344e8c-0df8-4ed2-a44c-5d1d3b55835d" ,
"credential_document" : "ddb46af0-a2c3-4ff4-9064-77707a5c7a53"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28 {
"type" : "object" ,
"properties" : {
"is_native" : {
"type" : "boolean" ,
"title" : "Is native language"
},
"degree" : {
"allOf" : [
{
"$ref" : "#/components/schemas/DegreeEnum"
}
],
"title" : "Language skill degree"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
},
"credential_document" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile attachment"
}
}
}
JSON {
"is_native" : true ,
"degree" : null ,
"profile" : "3370d4ce-d076-4511-9127-5254d7048f3f" ,
"credential_document" : "2067c878-540a-461a-b4f9-a2b053faaf9a"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28 {
"type" : "object" ,
"properties" : {
"is_native" : {
"type" : "boolean" ,
"title" : "Is native language"
},
"degree" : {
"allOf" : [
{
"$ref" : "#/components/schemas/DegreeEnum"
}
],
"title" : "Language skill degree"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
},
"credential_document" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile attachment"
}
}
}
JSON {
"is_native" : true ,
"degree" : null ,
"profile" : "362c30af-8bdc-4fae-8253-d72b2f685b26" ,
"credential_document" : "92428559-1364-4262-8acf-b38c9100966e"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28 {
"type" : "object" ,
"properties" : {
"is_native" : {
"type" : "boolean" ,
"title" : "Is native language"
},
"degree" : {
"allOf" : [
{
"$ref" : "#/components/schemas/DegreeEnum"
}
],
"title" : "Language skill degree"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
},
"credential_document" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile attachment"
}
}
}
Responses
HTTP 200 OK
application/json
JSON {
"id" : "f32f85cf-769a-4d1d-8037-ae65a060623a" ,
"language" : "0d06638b-5b54-4edd-8043-276021e1512b" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"is_native" : true ,
"degree" : null ,
"profile" : "f77b65b0-d0d6-4417-bebd-fe065a4e8c45" ,
"credential_document" : "5554bc46-f7a9-4e46-a5ca-c05f6db740ed"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"language" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"is_native" : {
"type" : "boolean" ,
"title" : "Is native language"
},
"degree" : {
"allOf" : [
{
"$ref" : "#/components/schemas/DegreeEnum"
}
],
"title" : "Language skill degree"
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
},
"credential_document" : {
"type" : "string" ,
"format" : "uuid" ,
"nullable" : true ,
"title" : "User profile attachment"
}
},
"required" : [
"created_at" ,
"degree" ,
"id" ,
"language" ,
"profile" ,
"updated_at"
]
}
DELETE
/api/v1/user-profile/{id} /language-knowledge/{language_knowledge_id}
Delete user profile language knowledge
Description
Delete specific user profile language knowledge
id * (required)
path
string
-
language_knowledge_id * (required)
path
string
-
Responses
HTTP 204 No Content
User Profile Payment Info
GET
/api/v1/user-profile/{id} /payment-info
List user profile payment info
Description
List specific user profile payment info
id * (required)
path
string
User profile identifier (id)
page
query
integer
A page number within the paginated result set.
Responses
HTTP 200 OK
application/json
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 {
"count" : 123 ,
"next" : "http://api.example.org/accounts/?page=4" ,
"previous" : "http://api.example.org/accounts/?page=2" ,
"results" : [
{
"id" : "035a441b-0962-419a-85a6-ddc8d3dac41d" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "e17a0c4c-582b-4950-9896-1df7fe64f8ed"
}
]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31 {
"type" : "object" ,
"required" : [
"count" ,
"results"
],
"properties" : {
"count" : {
"type" : "integer" ,
"example" : 123
},
"next" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=4"
},
"previous" : {
"type" : "string" ,
"nullable" : true ,
"format" : "uri" ,
"example" : "http://api.example.org/accounts/?page=2"
},
"results" : {
"type" : "array" ,
"items" : {
"$ref" : "#/components/schemas/ProfilePaymentInfoDetail"
}
}
}
}
POST
/api/v1/user-profile/{id} /payment-info
Create new payment info for user profile
id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "d3393db7-2097-422f-a800-41db01bc61c3"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33 {
"type" : "object" ,
"properties" : {
"account_holder_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"bank_identification_code" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Bank Identification Code (BIC)" ,
"maxLength" : 12
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_holder_name" ,
"account_number" ,
"bank_identification_code" ,
"profile"
]
}
JSON {
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "98a43a3d-b606-4b8e-a139-e874839a21f0"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33 {
"type" : "object" ,
"properties" : {
"account_holder_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"bank_identification_code" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Bank Identification Code (BIC)" ,
"maxLength" : 12
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_holder_name" ,
"account_number" ,
"bank_identification_code" ,
"profile"
]
}
JSON {
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "2e4fb986-90fd-4a49-ad63-657a8c709b77"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33 {
"type" : "object" ,
"properties" : {
"account_holder_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"bank_identification_code" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Bank Identification Code (BIC)" ,
"maxLength" : 12
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_holder_name" ,
"account_number" ,
"bank_identification_code" ,
"profile"
]
}
Responses
HTTP 201 Created
application/json
JSON {
"id" : "25b0dc2a-864f-4069-8e3c-dd3424cd6b4d" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "cee30cf9-307e-49be-aaac-f6f9e2ac7e5d"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"account_holder_name" : {
"type" : "string" ,
"maxLength" : 1024
},
"bank_identification_code" : {
"type" : "string" ,
"title" : "Bank Identification Code (BIC)" ,
"maxLength" : 12
},
"account_number" : {
"type" : "string" ,
"title" : "Account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_holder_name" ,
"account_number" ,
"bank_identification_code" ,
"created_at" ,
"id" ,
"profile" ,
"updated_at"
]
}
GET
/api/v1/user-profile/{id} /payment-info/{payment_info_id}
Get user profile payment info
Description
Retrieve specific user profile payment info
id * (required)
path
string
User profile identifier (id)
payment_info_id * (required)
path
string
-
Responses
HTTP 200 OK
application/json
JSON {
"id" : "a4380751-94fe-45f5-8194-9ea59fd6ec8a" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "127aefa7-7427-45d2-bf51-d8ee97aad12f"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"account_holder_name" : {
"type" : "string" ,
"maxLength" : 1024
},
"bank_identification_code" : {
"type" : "string" ,
"title" : "Bank Identification Code (BIC)" ,
"maxLength" : 12
},
"account_number" : {
"type" : "string" ,
"title" : "Account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_holder_name" ,
"account_number" ,
"bank_identification_code" ,
"created_at" ,
"id" ,
"profile" ,
"updated_at"
]
}
PATCH
/api/v1/user-profile/{id} /payment-info/{payment_info_id}
Update user profile payment info
Description
Update some fields of specific user profile payment info
id * (required)
path
string
User profile identifier (id)
payment_info_id * (required)
path
string
-
Request body
application/json application/x-www-form-urlencoded multipart/form-data
JSON {
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "91ef8c16-edea-4375-9f21-8dc5113bc767"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27 {
"type" : "object" ,
"properties" : {
"account_holder_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"bank_identification_code" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Bank Identification Code (BIC)" ,
"maxLength" : 12
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
}
}
JSON {
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "6775d1b6-45e6-4d82-8005-06d726ac5890"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27 {
"type" : "object" ,
"properties" : {
"account_holder_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"bank_identification_code" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Bank Identification Code (BIC)" ,
"maxLength" : 12
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
}
}
JSON {
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "5c3730e8-3296-4238-afe0-553ecee08641"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27 {
"type" : "object" ,
"properties" : {
"account_holder_name" : {
"type" : "string" ,
"minLength" : 1 ,
"maxLength" : 1024
},
"bank_identification_code" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Bank Identification Code (BIC)" ,
"maxLength" : 12
},
"account_number" : {
"type" : "string" ,
"minLength" : 1 ,
"title" : "Account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
}
}
Responses
HTTP 200 OK
application/json
JSON {
"id" : "54afc4ca-043c-4bf6-bc8a-9e630356a295" ,
"created_at" : "2022-04-13T15:42:05.901Z" ,
"updated_at" : "2022-04-13T15:42:05.901Z" ,
"account_holder_name" : "string" ,
"bank_identification_code" : "string" ,
"account_number" : "string" ,
"profile" : "b771d750-e34c-4b0b-9202-6f521b6d0400"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
JSON 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48 {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string" ,
"format" : "uuid" ,
"readOnly" : true
},
"created_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"updated_at" : {
"type" : "string" ,
"format" : "date-time" ,
"readOnly" : true
},
"account_holder_name" : {
"type" : "string" ,
"maxLength" : 1024
},
"bank_identification_code" : {
"type" : "string" ,
"title" : "Bank Identification Code (BIC)" ,
"maxLength" : 12
},
"account_number" : {
"type" : "string" ,
"title" : "Account number (IBAN)" ,
"maxLength" : 36
},
"profile" : {
"type" : "string" ,
"format" : "uuid" ,
"title" : "User profile"
}
},
"required" : [
"account_holder_name" ,
"account_number" ,
"bank_identification_code" ,
"created_at" ,
"id" ,
"profile" ,
"updated_at"
]
}
DELETE
/api/v1/user-profile/{id} /payment-info/{payment_info_id}
Delete user profile payment info
Description
Delete specific user profile payment info
id * (required)
path
string
User profile identifier (id)
payment_info_id * (required)
path
string
-
Responses
HTTP 204 No Content
Schemas
AttachmentCreateRequest
Name
Type
additional_document_fields
additional_document_infostring | null
document_assetstring (uuid )| null
expiration_datestring (date )| null
identification_valuestring | null
issuance_datestring (date )
issuerstring | null
profilestring (uuid )| null
AttachmentDetail
Name
Type
additional_document_fields
additional_document_infostring | null
created_atstring (date-time )
document_assetstring (uuid )| null
expiration_datestring (date )| null
idstring (uuid )
identification_valuestring | null
issuance_datestring (date )
issuerstring | null
profilestring (uuid )| null
updated_atstring (date-time )
BiographyVerificationStatusEnum
Type: string
Company
Name
Type
activity_scopesArray<string >
addressstring
created_atstring (date-time )
descriptionstring
documentsArray<string (uuid )>
idstring (uuid )
logo_imagestring (uri )
tax_identification_numberstring
titlestring
updated_atstring (date-time )
CompanyRequest
Name
Type
activity_scopesArray<string >
addressstring
descriptionstring
documentsArray<string (uuid )>
logo_imagestring (binary )
tax_identification_numberstring
titlestring
Type: string
Country
Name
Type
codestring
idstring (uuid )
titlestring
DegreeEnum
Type: string
DocumentTypeEnum
Type: string
ExperienceEntryCreateRequest
Name
Type
work_companystring
work_days_totalinteger
work_descriptionstring
work_positionstring
ExperienceEntryDetail
Name
Type
created_atstring (date-time )
idstring (uuid )
profilestring (uuid )
updated_atstring (date-time )
work_companystring
work_days_totalinteger
work_descriptionstring
work_positionstring
Name
Type
captionstring
document_typeDocumentTypeEnum
owned_by_companystring
owned_by_workerstring
FileUploadRequestRequest
GenderEnum
Type: string
Language
Name
Type
codestring
idstring (uuid )
titlestring
title_nationalstring
PaginatedAttachmentDetailList
Name
Type
countinteger
nextstring (uri )| null
previousstring (uri )| null
resultsArray<AttachmentDetail >
PaginatedCountryList
Name
Type
countinteger
nextstring (uri )| null
previousstring (uri )| null
resultsArray<Country >
PaginatedExperienceEntryDetailList
Name
Type
countinteger
nextstring (uri )| null
previousstring (uri )| null
resultsArray<ExperienceEntryDetail >
PaginatedLanguageList
Name
Type
countinteger
nextstring (uri )| null
previousstring (uri )| null
resultsArray<Language >
PaginatedProfileLanguageKnowledgeDetailList
PaginatedProfilePaymentInfoDetailList
PaginatedRegionList
Name
Type
countinteger
nextstring (uri )| null
previousstring (uri )| null
resultsArray<Region >
PaginatedSkillList
Name
Type
countinteger
nextstring (uri )| null
previousstring (uri )| null
resultsArray<Skill >
PaginatedSpecializationList
Name
Type
countinteger
nextstring (uri )| null
previousstring (uri )| null
resultsArray<Specialization >
PaginatedUserProfileDetailList
Name
Type
countinteger
nextstring (uri )| null
previousstring (uri )| null
resultsArray<UserProfileDetail >
PatchedAttachmentDetailRequest
Name
Type
additional_document_fields
additional_document_infostring | null
document_assetstring (uuid )| null
expiration_datestring (date )| null
identification_valuestring | null
issuance_datestring (date )
issuerstring | null
profilestring (uuid )| null
PatchedCompanyRequest
Name
Type
activity_scopesArray<string >
addressstring
descriptionstring
documentsArray<string (uuid )>
logo_imagestring (binary )
tax_identification_numberstring
titlestring
PatchedExperienceEntryDetailRequest
Name
Type
profilestring (uuid )
work_companystring
work_days_totalinteger
work_descriptionstring
work_positionstring
Name
Type
account_numberstring
addressstring | null
contact_namestring
contact_typeContactTypeEnum
emailstring (email )
phone_numberstring
profilestring (uuid )
salutation_type
salutation_valuestring
PatchedProfileLanguageKnowledgeDetailRequest
Name
Type
credential_documentstring (uuid )| null
degree
is_nativeboolean
profilestring (uuid )
PatchedProfilePaymentInfoDetailRequest
Name
Type
account_holder_namestring
account_numberstring
bank_identification_codestring
profilestring (uuid )
PatchedUserProfileDetailRequest
Name
Type
additional_emailstring (email )| null
addressstring
biographystring | null
biography_verification_statusBiographyVerificationStatusEnum
full_namestring
genderGenderEnum
ownerstring (uuid )
phone_numberstring
photostring (binary )| null
primary_emailstring (email )
titlestring
verification_statusVerificationStatusEnum
Name
Type
account_numberstring
addressstring | null
contact_namestring
contact_typeContactTypeEnum
created_atstring (date-time )
emailstring (email )
idstring (uuid )
phone_numberstring
profilestring (uuid )
salutation_type
salutation_valuestring
updated_atstring (date-time )
Name
Type
account_numberstring
addressstring | null
contact_namestring
contact_typeContactTypeEnum
emailstring (email )
phone_numberstring
profilestring (uuid )
salutation_type
salutation_valuestring
ProfileLanguageKnowledgeDetail
Name
Type
created_atstring (date-time )
credential_documentstring (uuid )| null
degree
idstring (uuid )
is_nativeboolean
languagestring (uuid )
profilestring (uuid )
updated_atstring (date-time )
ProfileLanguageKnowledgeDetailRequest
Name
Type
credential_documentstring (uuid )| null
degree
is_nativeboolean
profilestring (uuid )
ProfilePaymentInfoDetail
Name
Type
account_holder_namestring
account_numberstring
bank_identification_codestring
created_atstring (date-time )
idstring (uuid )
profilestring (uuid )
updated_atstring (date-time )
ProfilePaymentInfoDetailRequest
Name
Type
account_holder_namestring
account_numberstring
bank_identification_codestring
profilestring (uuid )
Region
Name
Type
codestring
idstring (uuid )
titlestring
SalutationTypeEnum
Type: string
Skill
Name
Type
codestring
descriptionstring
idstring (uuid )
titlestring
SkillRequest
Name
Type
codestring
descriptionstring
titlestring
Specialization
Name
Type
codestring
idstring (uuid )
occupationstring
qualificationstring
sectorstring
specializationstring
SpecializationRequest
Name
Type
codestring
occupationstring
qualificationstring
sectorstring
specializationstring
UserProfileDetail
Name
Type
additional_emailstring (email )| null
addressstring
biographystring | null
biography_verification_statusBiographyVerificationStatusEnum
created_atstring (date-time )
full_namestring
genderGenderEnum
idstring (uuid )
ownerstring (uuid )
phone_numberstring
photostring (uri )| null
primary_emailstring (email )
skillsArray<Skill >
specializationsArray<Specialization >
titlestring
updated_atstring (date-time )
verification_statusVerificationStatusEnum
UserProfileDetailRequest
Name
Type
additional_emailstring (email )| null
addressstring
biographystring | null
biography_verification_statusBiographyVerificationStatusEnum
full_namestring
genderGenderEnum
ownerstring (uuid )
phone_numberstring
photostring (binary )| null
primary_emailstring (email )
titlestring
verification_statusVerificationStatusEnum
VerificationStatusEnum
Type: string
Security schemes
Name
Type
Scheme
Description
jwtCookieAuth
apiKey
jwtHeaderAuth
http
bearer