---
title: "BGXML RTF Resume"
method: POST
path: "/parserservice/resume/rtf"
tags: ["Endpoints"]
---

# BGXML RTF Resume

`POST /parserservice/resume/rtf`

Returns a BGXML with RTF-formatted resume document from the resume parser.

## Request body

- ResumeRtfRequestJSON
  - `binaryData` string, required — Base64-encoded document data
  - `extension` string — The file extension of the document (e.g., 'pdf', 'docx', 'rtf')
  - `locale` string — Locale in which to process the document (e.g., 'en_us')
  - `instanceType` string, required — Processing engine or product instance (e.g., 'SPECTRUM')
  - `customParameters` string — Optional custom parameters for processing
  - `fieldList` object — List of fields to extract
    - `field` string[]

## Response `200`

OK

- ResumeRtfResponseJSON
  - `status` boolean — Indicates whether the request was successful.
  - `statusCode` string — Status code of the response.
  - `requestId` string — Unique ID for tracking the request.
  - `responseData` object
    - `ResDoc` object
      - `resume` object[]
        - `contact` object[]
          - `name` object[]
            - `givenname` string[]
            - `surname` string[]
          - `phone` object[]
            - `value` string
            - `@area` string
          - `email` object[]
            - `value` string, email
          - `address` object[]
            - `street` string[]
            - `city` object[]
              - …
          - `#text` string[]
        - `education` object[]
          - `school` object[]
            - `daterange` object[]
              - …
            - `institution` object[]
              - …
            - `major` object[]
              - …
            - `gpa` object[]
              - …
            - `degree` object[]
              - …
            - `#text` string[]
            - `@id` string
      - `DataElementsRollup` object[]
        - `@version` string
      - `rtfdoc` string[]
  - `timeStamp` string, date-time — Timestamp when the response was generated.
  - `processedWithLocale` string — The locale used for processing the resume.

---

[API](https://skmtc.net/lightcast/apis/alumni-pathways-2-0.md) · [All operations](https://skmtc.net/lightcast/apis/alumni-pathways-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightcast/alumni-pathways-2-0/revisions/fc66b9877391/schema)